volcengine.rocketmq.RocketMQInstance
Explore with Pulumi AI
Provides a resource to manage rocketmq instance
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 fooRocketMQInstance = new volcengine.rocketmq.RocketMQInstance("fooRocketMQInstance", {
zoneIds: [fooZones.then(fooZones => fooZones.zones?.[0]?.id)],
subnetId: fooSubnet.id,
version: "4.8",
computeSpec: "rocketmq.n1.x2.micro",
storageSpace: 300,
autoScaleQueue: true,
fileReservedTime: 10,
instanceName: "acc-test-rocketmq",
instanceDescription: "acc-test",
projectName: "default",
chargeInfo: {
chargeType: "PostPaid",
},
tags: [{
key: "k1",
value: "v1",
}],
});
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_rocket_mq_instance = volcengine.rocketmq.RocketMQInstance("fooRocketMQInstance",
zone_ids=[foo_zones.zones[0].id],
subnet_id=foo_subnet.id,
version="4.8",
compute_spec="rocketmq.n1.x2.micro",
storage_space=300,
auto_scale_queue=True,
file_reserved_time=10,
instance_name="acc-test-rocketmq",
instance_description="acc-test",
project_name="default",
charge_info=volcengine.rocketmq.RocketMQInstanceChargeInfoArgs(
charge_type="PostPaid",
),
tags=[volcengine.rocketmq.RocketMQInstanceTagArgs(
key="k1",
value="v1",
)])
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/rocketmq"
"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
}
_, err = rocketmq.NewRocketMQInstance(ctx, "fooRocketMQInstance", &rocketmq.RocketMQInstanceArgs{
ZoneIds: pulumi.StringArray{
pulumi.String(fooZones.Zones[0].Id),
},
SubnetId: fooSubnet.ID(),
Version: pulumi.String("4.8"),
ComputeSpec: pulumi.String("rocketmq.n1.x2.micro"),
StorageSpace: pulumi.Int(300),
AutoScaleQueue: pulumi.Bool(true),
FileReservedTime: pulumi.Int(10),
InstanceName: pulumi.String("acc-test-rocketmq"),
InstanceDescription: pulumi.String("acc-test"),
ProjectName: pulumi.String("default"),
ChargeInfo: &rocketmq.RocketMQInstanceChargeInfoArgs{
ChargeType: pulumi.String("PostPaid"),
},
Tags: rocketmq.RocketMQInstanceTagArray{
&rocketmq.RocketMQInstanceTagArgs{
Key: pulumi.String("k1"),
Value: pulumi.String("v1"),
},
},
})
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 fooRocketMQInstance = new Volcengine.Rocketmq.RocketMQInstance("fooRocketMQInstance", new()
{
ZoneIds = new[]
{
fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
},
SubnetId = fooSubnet.Id,
Version = "4.8",
ComputeSpec = "rocketmq.n1.x2.micro",
StorageSpace = 300,
AutoScaleQueue = true,
FileReservedTime = 10,
InstanceName = "acc-test-rocketmq",
InstanceDescription = "acc-test",
ProjectName = "default",
ChargeInfo = new Volcengine.Rocketmq.Inputs.RocketMQInstanceChargeInfoArgs
{
ChargeType = "PostPaid",
},
Tags = new[]
{
new Volcengine.Rocketmq.Inputs.RocketMQInstanceTagArgs
{
Key = "k1",
Value = "v1",
},
},
});
});
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.rocketmq.RocketMQInstance;
import com.pulumi.volcengine.rocketmq.RocketMQInstanceArgs;
import com.pulumi.volcengine.rocketmq.inputs.RocketMQInstanceChargeInfoArgs;
import com.pulumi.volcengine.rocketmq.inputs.RocketMQInstanceTagArgs;
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 fooRocketMQInstance = new RocketMQInstance("fooRocketMQInstance", RocketMQInstanceArgs.builder()
.zoneIds(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
.subnetId(fooSubnet.id())
.version("4.8")
.computeSpec("rocketmq.n1.x2.micro")
.storageSpace(300)
.autoScaleQueue(true)
.fileReservedTime(10)
.instanceName("acc-test-rocketmq")
.instanceDescription("acc-test")
.projectName("default")
.chargeInfo(RocketMQInstanceChargeInfoArgs.builder()
.chargeType("PostPaid")
.build())
.tags(RocketMQInstanceTagArgs.builder()
.key("k1")
.value("v1")
.build())
.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}
fooRocketMQInstance:
type: volcengine:rocketmq:RocketMQInstance
properties:
zoneIds:
- ${fooZones.zones[0].id}
subnetId: ${fooSubnet.id}
version: '4.8'
computeSpec: rocketmq.n1.x2.micro
storageSpace: 300
autoScaleQueue: true
fileReservedTime: 10
instanceName: acc-test-rocketmq
instanceDescription: acc-test
projectName: default
chargeInfo:
chargeType: PostPaid
tags:
- key: k1
value: v1
variables:
fooZones:
fn::invoke:
Function: volcengine:ecs:Zones
Arguments: {}
Create RocketMQInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RocketMQInstance(name: string, args: RocketMQInstanceArgs, opts?: CustomResourceOptions);
@overload
def RocketMQInstance(resource_name: str,
args: RocketMQInstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RocketMQInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
charge_info: Optional[RocketMQInstanceChargeInfoArgs] = None,
compute_spec: Optional[str] = None,
file_reserved_time: Optional[int] = None,
storage_space: Optional[int] = None,
subnet_id: Optional[str] = None,
version: Optional[str] = None,
zone_ids: Optional[Sequence[str]] = None,
auto_scale_queue: Optional[bool] = None,
instance_description: Optional[str] = None,
instance_name: Optional[str] = None,
project_name: Optional[str] = None,
tags: Optional[Sequence[RocketMQInstanceTagArgs]] = None)
func NewRocketMQInstance(ctx *Context, name string, args RocketMQInstanceArgs, opts ...ResourceOption) (*RocketMQInstance, error)
public RocketMQInstance(string name, RocketMQInstanceArgs args, CustomResourceOptions? opts = null)
public RocketMQInstance(String name, RocketMQInstanceArgs args)
public RocketMQInstance(String name, RocketMQInstanceArgs args, CustomResourceOptions options)
type: volcengine:rocketmq:RocketMQInstance
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 RocketMQInstanceArgs
- 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 RocketMQInstanceArgs
- 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 RocketMQInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RocketMQInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RocketMQInstanceArgs
- 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 rocketMQInstanceResource = new Volcengine.Rocketmq.RocketMQInstance("rocketMQInstanceResource", new()
{
ChargeInfo = new Volcengine.Rocketmq.Inputs.RocketMQInstanceChargeInfoArgs
{
ChargeType = "string",
AutoRenew = false,
Period = 0,
PeriodUnit = "string",
},
ComputeSpec = "string",
FileReservedTime = 0,
StorageSpace = 0,
SubnetId = "string",
Version = "string",
ZoneIds = new[]
{
"string",
},
AutoScaleQueue = false,
InstanceDescription = "string",
InstanceName = "string",
ProjectName = "string",
Tags = new[]
{
new Volcengine.Rocketmq.Inputs.RocketMQInstanceTagArgs
{
Key = "string",
Value = "string",
},
},
});
example, err := rocketmq.NewRocketMQInstance(ctx, "rocketMQInstanceResource", &rocketmq.RocketMQInstanceArgs{
ChargeInfo: &rocketmq.RocketMQInstanceChargeInfoArgs{
ChargeType: pulumi.String("string"),
AutoRenew: pulumi.Bool(false),
Period: pulumi.Int(0),
PeriodUnit: pulumi.String("string"),
},
ComputeSpec: pulumi.String("string"),
FileReservedTime: pulumi.Int(0),
StorageSpace: pulumi.Int(0),
SubnetId: pulumi.String("string"),
Version: pulumi.String("string"),
ZoneIds: pulumi.StringArray{
pulumi.String("string"),
},
AutoScaleQueue: pulumi.Bool(false),
InstanceDescription: pulumi.String("string"),
InstanceName: pulumi.String("string"),
ProjectName: pulumi.String("string"),
Tags: rocketmq.RocketMQInstanceTagArray{
&rocketmq.RocketMQInstanceTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
})
var rocketMQInstanceResource = new RocketMQInstance("rocketMQInstanceResource", RocketMQInstanceArgs.builder()
.chargeInfo(RocketMQInstanceChargeInfoArgs.builder()
.chargeType("string")
.autoRenew(false)
.period(0)
.periodUnit("string")
.build())
.computeSpec("string")
.fileReservedTime(0)
.storageSpace(0)
.subnetId("string")
.version("string")
.zoneIds("string")
.autoScaleQueue(false)
.instanceDescription("string")
.instanceName("string")
.projectName("string")
.tags(RocketMQInstanceTagArgs.builder()
.key("string")
.value("string")
.build())
.build());
rocket_mq_instance_resource = volcengine.rocketmq.RocketMQInstance("rocketMQInstanceResource",
charge_info={
"charge_type": "string",
"auto_renew": False,
"period": 0,
"period_unit": "string",
},
compute_spec="string",
file_reserved_time=0,
storage_space=0,
subnet_id="string",
version="string",
zone_ids=["string"],
auto_scale_queue=False,
instance_description="string",
instance_name="string",
project_name="string",
tags=[{
"key": "string",
"value": "string",
}])
const rocketMQInstanceResource = new volcengine.rocketmq.RocketMQInstance("rocketMQInstanceResource", {
chargeInfo: {
chargeType: "string",
autoRenew: false,
period: 0,
periodUnit: "string",
},
computeSpec: "string",
fileReservedTime: 0,
storageSpace: 0,
subnetId: "string",
version: "string",
zoneIds: ["string"],
autoScaleQueue: false,
instanceDescription: "string",
instanceName: "string",
projectName: "string",
tags: [{
key: "string",
value: "string",
}],
});
type: volcengine:rocketmq:RocketMQInstance
properties:
autoScaleQueue: false
chargeInfo:
autoRenew: false
chargeType: string
period: 0
periodUnit: string
computeSpec: string
fileReservedTime: 0
instanceDescription: string
instanceName: string
projectName: string
storageSpace: 0
subnetId: string
tags:
- key: string
value: string
version: string
zoneIds:
- string
RocketMQInstance 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 RocketMQInstance resource accepts the following input properties:
- Charge
Info RocketMQInstance Charge Info - The charge information of the rocketmq instance.
- Compute
Spec string - The compute spec of the rocketmq instance.
- File
Reserved intTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- Storage
Space int - The storage space of the rocketmq instance.
- Subnet
Id string - The subnet id of the rocketmq instance.
- Version string
- The version of the rocketmq instance. Valid values:
4.8
. - Zone
Ids List<string> - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- Auto
Scale boolQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - Instance
Description string - The instance description of the rocketmq instance.
- Instance
Name string - The instance name of the rocketmq instance.
- Project
Name string - The project name of the rocketmq instance.
- List<Rocket
MQInstance Tag> - Tags.
- Charge
Info RocketMQInstance Charge Info Args - The charge information of the rocketmq instance.
- Compute
Spec string - The compute spec of the rocketmq instance.
- File
Reserved intTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- Storage
Space int - The storage space of the rocketmq instance.
- Subnet
Id string - The subnet id of the rocketmq instance.
- Version string
- The version of the rocketmq instance. Valid values:
4.8
. - Zone
Ids []string - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- Auto
Scale boolQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - Instance
Description string - The instance description of the rocketmq instance.
- Instance
Name string - The instance name of the rocketmq instance.
- Project
Name string - The project name of the rocketmq instance.
- []Rocket
MQInstance Tag Args - Tags.
- charge
Info RocketMQInstance Charge Info - The charge information of the rocketmq instance.
- compute
Spec String - The compute spec of the rocketmq instance.
- file
Reserved IntegerTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- storage
Space Integer - The storage space of the rocketmq instance.
- subnet
Id String - The subnet id of the rocketmq instance.
- version String
- The version of the rocketmq instance. Valid values:
4.8
. - zone
Ids List<String> - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- auto
Scale BooleanQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - instance
Description String - The instance description of the rocketmq instance.
- instance
Name String - The instance name of the rocketmq instance.
- project
Name String - The project name of the rocketmq instance.
- List<Rocket
MQInstance Tag> - Tags.
- charge
Info RocketMQInstance Charge Info - The charge information of the rocketmq instance.
- compute
Spec string - The compute spec of the rocketmq instance.
- file
Reserved numberTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- storage
Space number - The storage space of the rocketmq instance.
- subnet
Id string - The subnet id of the rocketmq instance.
- version string
- The version of the rocketmq instance. Valid values:
4.8
. - zone
Ids string[] - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- auto
Scale booleanQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - instance
Description string - The instance description of the rocketmq instance.
- instance
Name string - The instance name of the rocketmq instance.
- project
Name string - The project name of the rocketmq instance.
- Rocket
MQInstance Tag[] - Tags.
- charge_
info RocketMQInstance Charge Info Args - The charge information of the rocketmq instance.
- compute_
spec str - The compute spec of the rocketmq instance.
- file_
reserved_ inttime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- storage_
space int - The storage space of the rocketmq instance.
- subnet_
id str - The subnet id of the rocketmq instance.
- version str
- The version of the rocketmq instance. Valid values:
4.8
. - zone_
ids Sequence[str] - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- auto_
scale_ boolqueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - instance_
description str - The instance description of the rocketmq instance.
- instance_
name str - The instance name of the rocketmq instance.
- project_
name str - The project name of the rocketmq instance.
- Sequence[Rocket
MQInstance Tag Args] - Tags.
- charge
Info Property Map - The charge information of the rocketmq instance.
- compute
Spec String - The compute spec of the rocketmq instance.
- file
Reserved NumberTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- storage
Space Number - The storage space of the rocketmq instance.
- subnet
Id String - The subnet id of the rocketmq instance.
- version String
- The version of the rocketmq instance. Valid values:
4.8
. - zone
Ids List<String> - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- auto
Scale BooleanQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - instance
Description String - The instance description of the rocketmq instance.
- instance
Name String - The instance name of the rocketmq instance.
- project
Name String - The project name of the rocketmq instance.
- List<Property Map>
- Tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the RocketMQInstance resource produces the following output properties:
- Account
Id string - The account id of the rocketmq instance.
- Apply
Private boolDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- Available
Queue intNumber - The available queue number of the rocketmq instance.
- Connection
Infos List<RocketMQInstance Connection Info> - The connection information of the rocketmq.
- Create
Time string - The create time of the rocketmq instance.
- Eip
Id string - The eip id of the rocketmq instance.
- Enable
Ssl bool - Whether the ssl authentication is enabled for the rocketmq instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Status string - The status of the rocketmq instance.
- Region
Id string - The region id of the rocketmq instance.
- Ssl
Mode string - The ssl mode of the rocketmq instance.
- Used
Group intNumber - The used group number of the rocketmq instance.
- Used
Queue intNumber - The used queue number of the rocketmq instance.
- Used
Storage intSpace - The used storage space of the rocketmq instance.
- Used
Topic intNumber - The used topic number of the rocketmq instance.
- Vpc
Id string - The vpc id of the rocketmq instance.
- Account
Id string - The account id of the rocketmq instance.
- Apply
Private boolDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- Available
Queue intNumber - The available queue number of the rocketmq instance.
- Connection
Infos []RocketMQInstance Connection Info - The connection information of the rocketmq.
- Create
Time string - The create time of the rocketmq instance.
- Eip
Id string - The eip id of the rocketmq instance.
- Enable
Ssl bool - Whether the ssl authentication is enabled for the rocketmq instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Status string - The status of the rocketmq instance.
- Region
Id string - The region id of the rocketmq instance.
- Ssl
Mode string - The ssl mode of the rocketmq instance.
- Used
Group intNumber - The used group number of the rocketmq instance.
- Used
Queue intNumber - The used queue number of the rocketmq instance.
- Used
Storage intSpace - The used storage space of the rocketmq instance.
- Used
Topic intNumber - The used topic number of the rocketmq instance.
- Vpc
Id string - The vpc id of the rocketmq instance.
- account
Id String - The account id of the rocketmq instance.
- apply
Private BooleanDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- available
Queue IntegerNumber - The available queue number of the rocketmq instance.
- connection
Infos List<RocketMQInstance Connection Info> - The connection information of the rocketmq.
- create
Time String - The create time of the rocketmq instance.
- eip
Id String - The eip id of the rocketmq instance.
- enable
Ssl Boolean - Whether the ssl authentication is enabled for the rocketmq instance.
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Status String - The status of the rocketmq instance.
- region
Id String - The region id of the rocketmq instance.
- ssl
Mode String - The ssl mode of the rocketmq instance.
- used
Group IntegerNumber - The used group number of the rocketmq instance.
- used
Queue IntegerNumber - The used queue number of the rocketmq instance.
- used
Storage IntegerSpace - The used storage space of the rocketmq instance.
- used
Topic IntegerNumber - The used topic number of the rocketmq instance.
- vpc
Id String - The vpc id of the rocketmq instance.
- account
Id string - The account id of the rocketmq instance.
- apply
Private booleanDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- available
Queue numberNumber - The available queue number of the rocketmq instance.
- connection
Infos RocketMQInstance Connection Info[] - The connection information of the rocketmq.
- create
Time string - The create time of the rocketmq instance.
- eip
Id string - The eip id of the rocketmq instance.
- enable
Ssl boolean - Whether the ssl authentication is enabled for the rocketmq instance.
- id string
- The provider-assigned unique ID for this managed resource.
- instance
Status string - The status of the rocketmq instance.
- region
Id string - The region id of the rocketmq instance.
- ssl
Mode string - The ssl mode of the rocketmq instance.
- used
Group numberNumber - The used group number of the rocketmq instance.
- used
Queue numberNumber - The used queue number of the rocketmq instance.
- used
Storage numberSpace - The used storage space of the rocketmq instance.
- used
Topic numberNumber - The used topic number of the rocketmq instance.
- vpc
Id string - The vpc id of the rocketmq instance.
- account_
id str - The account id of the rocketmq instance.
- apply_
private_ booldns_ to_ public - Whether the private dns to public function is enabled for the rocketmq instance.
- available_
queue_ intnumber - The available queue number of the rocketmq instance.
- connection_
infos Sequence[RocketMQInstance Connection Info] - The connection information of the rocketmq.
- create_
time str - The create time of the rocketmq instance.
- eip_
id str - The eip id of the rocketmq instance.
- enable_
ssl bool - Whether the ssl authentication is enabled for the rocketmq instance.
- id str
- The provider-assigned unique ID for this managed resource.
- instance_
status str - The status of the rocketmq instance.
- region_
id str - The region id of the rocketmq instance.
- ssl_
mode str - The ssl mode of the rocketmq instance.
- used_
group_ intnumber - The used group number of the rocketmq instance.
- used_
queue_ intnumber - The used queue number of the rocketmq instance.
- used_
storage_ intspace - The used storage space of the rocketmq instance.
- used_
topic_ intnumber - The used topic number of the rocketmq instance.
- vpc_
id str - The vpc id of the rocketmq instance.
- account
Id String - The account id of the rocketmq instance.
- apply
Private BooleanDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- available
Queue NumberNumber - The available queue number of the rocketmq instance.
- connection
Infos List<Property Map> - The connection information of the rocketmq.
- create
Time String - The create time of the rocketmq instance.
- eip
Id String - The eip id of the rocketmq instance.
- enable
Ssl Boolean - Whether the ssl authentication is enabled for the rocketmq instance.
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Status String - The status of the rocketmq instance.
- region
Id String - The region id of the rocketmq instance.
- ssl
Mode String - The ssl mode of the rocketmq instance.
- used
Group NumberNumber - The used group number of the rocketmq instance.
- used
Queue NumberNumber - The used queue number of the rocketmq instance.
- used
Storage NumberSpace - The used storage space of the rocketmq instance.
- used
Topic NumberNumber - The used topic number of the rocketmq instance.
- vpc
Id String - The vpc id of the rocketmq instance.
Look up Existing RocketMQInstance Resource
Get an existing RocketMQInstance 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?: RocketMQInstanceState, opts?: CustomResourceOptions): RocketMQInstance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
apply_private_dns_to_public: Optional[bool] = None,
auto_scale_queue: Optional[bool] = None,
available_queue_number: Optional[int] = None,
charge_info: Optional[RocketMQInstanceChargeInfoArgs] = None,
compute_spec: Optional[str] = None,
connection_infos: Optional[Sequence[RocketMQInstanceConnectionInfoArgs]] = None,
create_time: Optional[str] = None,
eip_id: Optional[str] = None,
enable_ssl: Optional[bool] = None,
file_reserved_time: Optional[int] = None,
instance_description: Optional[str] = None,
instance_name: Optional[str] = None,
instance_status: Optional[str] = None,
project_name: Optional[str] = None,
region_id: Optional[str] = None,
ssl_mode: Optional[str] = None,
storage_space: Optional[int] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[RocketMQInstanceTagArgs]] = None,
used_group_number: Optional[int] = None,
used_queue_number: Optional[int] = None,
used_storage_space: Optional[int] = None,
used_topic_number: Optional[int] = None,
version: Optional[str] = None,
vpc_id: Optional[str] = None,
zone_ids: Optional[Sequence[str]] = None) -> RocketMQInstance
func GetRocketMQInstance(ctx *Context, name string, id IDInput, state *RocketMQInstanceState, opts ...ResourceOption) (*RocketMQInstance, error)
public static RocketMQInstance Get(string name, Input<string> id, RocketMQInstanceState? state, CustomResourceOptions? opts = null)
public static RocketMQInstance get(String name, Output<String> id, RocketMQInstanceState state, CustomResourceOptions options)
resources: _: type: volcengine:rocketmq:RocketMQInstance 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.
- Account
Id string - The account id of the rocketmq instance.
- Apply
Private boolDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- Auto
Scale boolQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - Available
Queue intNumber - The available queue number of the rocketmq instance.
- Charge
Info RocketMQInstance Charge Info - The charge information of the rocketmq instance.
- Compute
Spec string - The compute spec of the rocketmq instance.
- Connection
Infos List<RocketMQInstance Connection Info> - The connection information of the rocketmq.
- Create
Time string - The create time of the rocketmq instance.
- Eip
Id string - The eip id of the rocketmq instance.
- Enable
Ssl bool - Whether the ssl authentication is enabled for the rocketmq instance.
- File
Reserved intTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- Instance
Description string - The instance description of the rocketmq instance.
- Instance
Name string - The instance name of the rocketmq instance.
- Instance
Status string - The status of the rocketmq instance.
- Project
Name string - The project name of the rocketmq instance.
- Region
Id string - The region id of the rocketmq instance.
- Ssl
Mode string - The ssl mode of the rocketmq instance.
- Storage
Space int - The storage space of the rocketmq instance.
- Subnet
Id string - The subnet id of the rocketmq instance.
- List<Rocket
MQInstance Tag> - Tags.
- Used
Group intNumber - The used group number of the rocketmq instance.
- Used
Queue intNumber - The used queue number of the rocketmq instance.
- Used
Storage intSpace - The used storage space of the rocketmq instance.
- Used
Topic intNumber - The used topic number of the rocketmq instance.
- Version string
- The version of the rocketmq instance. Valid values:
4.8
. - Vpc
Id string - The vpc id of the rocketmq instance.
- Zone
Ids List<string> - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- Account
Id string - The account id of the rocketmq instance.
- Apply
Private boolDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- Auto
Scale boolQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - Available
Queue intNumber - The available queue number of the rocketmq instance.
- Charge
Info RocketMQInstance Charge Info Args - The charge information of the rocketmq instance.
- Compute
Spec string - The compute spec of the rocketmq instance.
- Connection
Infos []RocketMQInstance Connection Info Args - The connection information of the rocketmq.
- Create
Time string - The create time of the rocketmq instance.
- Eip
Id string - The eip id of the rocketmq instance.
- Enable
Ssl bool - Whether the ssl authentication is enabled for the rocketmq instance.
- File
Reserved intTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- Instance
Description string - The instance description of the rocketmq instance.
- Instance
Name string - The instance name of the rocketmq instance.
- Instance
Status string - The status of the rocketmq instance.
- Project
Name string - The project name of the rocketmq instance.
- Region
Id string - The region id of the rocketmq instance.
- Ssl
Mode string - The ssl mode of the rocketmq instance.
- Storage
Space int - The storage space of the rocketmq instance.
- Subnet
Id string - The subnet id of the rocketmq instance.
- []Rocket
MQInstance Tag Args - Tags.
- Used
Group intNumber - The used group number of the rocketmq instance.
- Used
Queue intNumber - The used queue number of the rocketmq instance.
- Used
Storage intSpace - The used storage space of the rocketmq instance.
- Used
Topic intNumber - The used topic number of the rocketmq instance.
- Version string
- The version of the rocketmq instance. Valid values:
4.8
. - Vpc
Id string - The vpc id of the rocketmq instance.
- Zone
Ids []string - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- account
Id String - The account id of the rocketmq instance.
- apply
Private BooleanDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- auto
Scale BooleanQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - available
Queue IntegerNumber - The available queue number of the rocketmq instance.
- charge
Info RocketMQInstance Charge Info - The charge information of the rocketmq instance.
- compute
Spec String - The compute spec of the rocketmq instance.
- connection
Infos List<RocketMQInstance Connection Info> - The connection information of the rocketmq.
- create
Time String - The create time of the rocketmq instance.
- eip
Id String - The eip id of the rocketmq instance.
- enable
Ssl Boolean - Whether the ssl authentication is enabled for the rocketmq instance.
- file
Reserved IntegerTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- instance
Description String - The instance description of the rocketmq instance.
- instance
Name String - The instance name of the rocketmq instance.
- instance
Status String - The status of the rocketmq instance.
- project
Name String - The project name of the rocketmq instance.
- region
Id String - The region id of the rocketmq instance.
- ssl
Mode String - The ssl mode of the rocketmq instance.
- storage
Space Integer - The storage space of the rocketmq instance.
- subnet
Id String - The subnet id of the rocketmq instance.
- List<Rocket
MQInstance Tag> - Tags.
- used
Group IntegerNumber - The used group number of the rocketmq instance.
- used
Queue IntegerNumber - The used queue number of the rocketmq instance.
- used
Storage IntegerSpace - The used storage space of the rocketmq instance.
- used
Topic IntegerNumber - The used topic number of the rocketmq instance.
- version String
- The version of the rocketmq instance. Valid values:
4.8
. - vpc
Id String - The vpc id of the rocketmq instance.
- zone
Ids List<String> - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- account
Id string - The account id of the rocketmq instance.
- apply
Private booleanDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- auto
Scale booleanQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - available
Queue numberNumber - The available queue number of the rocketmq instance.
- charge
Info RocketMQInstance Charge Info - The charge information of the rocketmq instance.
- compute
Spec string - The compute spec of the rocketmq instance.
- connection
Infos RocketMQInstance Connection Info[] - The connection information of the rocketmq.
- create
Time string - The create time of the rocketmq instance.
- eip
Id string - The eip id of the rocketmq instance.
- enable
Ssl boolean - Whether the ssl authentication is enabled for the rocketmq instance.
- file
Reserved numberTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- instance
Description string - The instance description of the rocketmq instance.
- instance
Name string - The instance name of the rocketmq instance.
- instance
Status string - The status of the rocketmq instance.
- project
Name string - The project name of the rocketmq instance.
- region
Id string - The region id of the rocketmq instance.
- ssl
Mode string - The ssl mode of the rocketmq instance.
- storage
Space number - The storage space of the rocketmq instance.
- subnet
Id string - The subnet id of the rocketmq instance.
- Rocket
MQInstance Tag[] - Tags.
- used
Group numberNumber - The used group number of the rocketmq instance.
- used
Queue numberNumber - The used queue number of the rocketmq instance.
- used
Storage numberSpace - The used storage space of the rocketmq instance.
- used
Topic numberNumber - The used topic number of the rocketmq instance.
- version string
- The version of the rocketmq instance. Valid values:
4.8
. - vpc
Id string - The vpc id of the rocketmq instance.
- zone
Ids string[] - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- account_
id str - The account id of the rocketmq instance.
- apply_
private_ booldns_ to_ public - Whether the private dns to public function is enabled for the rocketmq instance.
- auto_
scale_ boolqueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - available_
queue_ intnumber - The available queue number of the rocketmq instance.
- charge_
info RocketMQInstance Charge Info Args - The charge information of the rocketmq instance.
- compute_
spec str - The compute spec of the rocketmq instance.
- connection_
infos Sequence[RocketMQInstance Connection Info Args] - The connection information of the rocketmq.
- create_
time str - The create time of the rocketmq instance.
- eip_
id str - The eip id of the rocketmq instance.
- enable_
ssl bool - Whether the ssl authentication is enabled for the rocketmq instance.
- file_
reserved_ inttime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- instance_
description str - The instance description of the rocketmq instance.
- instance_
name str - The instance name of the rocketmq instance.
- instance_
status str - The status of the rocketmq instance.
- project_
name str - The project name of the rocketmq instance.
- region_
id str - The region id of the rocketmq instance.
- ssl_
mode str - The ssl mode of the rocketmq instance.
- storage_
space int - The storage space of the rocketmq instance.
- subnet_
id str - The subnet id of the rocketmq instance.
- Sequence[Rocket
MQInstance Tag Args] - Tags.
- used_
group_ intnumber - The used group number of the rocketmq instance.
- used_
queue_ intnumber - The used queue number of the rocketmq instance.
- used_
storage_ intspace - The used storage space of the rocketmq instance.
- used_
topic_ intnumber - The used topic number of the rocketmq instance.
- version str
- The version of the rocketmq instance. Valid values:
4.8
. - vpc_
id str - The vpc id of the rocketmq instance.
- zone_
ids Sequence[str] - The zone id of the rocketmq instance. Support specifying multiple availability zones.
- account
Id String - The account id of the rocketmq instance.
- apply
Private BooleanDns To Public - Whether the private dns to public function is enabled for the rocketmq instance.
- auto
Scale BooleanQueue - Whether to create queue automatically when the spec of the instance is changed. This field is effective only when modifying
compute_field
andstorage_space
. - available
Queue NumberNumber - The available queue number of the rocketmq instance.
- charge
Info Property Map - The charge information of the rocketmq instance.
- compute
Spec String - The compute spec of the rocketmq instance.
- connection
Infos List<Property Map> - The connection information of the rocketmq.
- create
Time String - The create time of the rocketmq instance.
- eip
Id String - The eip id of the rocketmq instance.
- enable
Ssl Boolean - Whether the ssl authentication is enabled for the rocketmq instance.
- file
Reserved NumberTime - The reserved time of messages on the RocketMQ server of the message queue. Messages that exceed the reserved time will be cleared after expiration. The unit is in hours. Valid value range is 1~72.
- instance
Description String - The instance description of the rocketmq instance.
- instance
Name String - The instance name of the rocketmq instance.
- instance
Status String - The status of the rocketmq instance.
- project
Name String - The project name of the rocketmq instance.
- region
Id String - The region id of the rocketmq instance.
- ssl
Mode String - The ssl mode of the rocketmq instance.
- storage
Space Number - The storage space of the rocketmq instance.
- subnet
Id String - The subnet id of the rocketmq instance.
- List<Property Map>
- Tags.
- used
Group NumberNumber - The used group number of the rocketmq instance.
- used
Queue NumberNumber - The used queue number of the rocketmq instance.
- used
Storage NumberSpace - The used storage space of the rocketmq instance.
- used
Topic NumberNumber - The used topic number of the rocketmq instance.
- version String
- The version of the rocketmq instance. Valid values:
4.8
. - vpc
Id String - The vpc id of the rocketmq instance.
- zone
Ids List<String> - The zone id of the rocketmq instance. Support specifying multiple availability zones.
Supporting Types
RocketMQInstanceChargeInfo, RocketMQInstanceChargeInfoArgs
- Charge
Type string - The charge type of the rocketmq instance. Valid values:
PostPaid
,PrePaid
. - Auto
Renew bool - Whether to automatically renew in prepaid scenarios. Default is false.
- Period int
- Purchase duration in prepaid scenarios. When PeriodUnit is specified as
Monthly
, the value range is 1-9. When PeriodUnit is specified asYearly
, the value range is 1-3. Default is 1. - Period
Unit string - The purchase cycle in the prepaid scenario. Valid values:
Monthly
,Yearly
. Default isMonthly
.
- Charge
Type string - The charge type of the rocketmq instance. Valid values:
PostPaid
,PrePaid
. - Auto
Renew bool - Whether to automatically renew in prepaid scenarios. Default is false.
- Period int
- Purchase duration in prepaid scenarios. When PeriodUnit is specified as
Monthly
, the value range is 1-9. When PeriodUnit is specified asYearly
, the value range is 1-3. Default is 1. - Period
Unit string - The purchase cycle in the prepaid scenario. Valid values:
Monthly
,Yearly
. Default isMonthly
.
- charge
Type String - The charge type of the rocketmq instance. Valid values:
PostPaid
,PrePaid
. - auto
Renew Boolean - Whether to automatically renew in prepaid scenarios. Default is false.
- period Integer
- Purchase duration in prepaid scenarios. When PeriodUnit is specified as
Monthly
, the value range is 1-9. When PeriodUnit is specified asYearly
, the value range is 1-3. Default is 1. - period
Unit String - The purchase cycle in the prepaid scenario. Valid values:
Monthly
,Yearly
. Default isMonthly
.
- charge
Type string - The charge type of the rocketmq instance. Valid values:
PostPaid
,PrePaid
. - auto
Renew boolean - Whether to automatically renew in prepaid scenarios. Default is false.
- period number
- Purchase duration in prepaid scenarios. When PeriodUnit is specified as
Monthly
, the value range is 1-9. When PeriodUnit is specified asYearly
, the value range is 1-3. Default is 1. - period
Unit string - The purchase cycle in the prepaid scenario. Valid values:
Monthly
,Yearly
. Default isMonthly
.
- charge_
type str - The charge type of the rocketmq instance. Valid values:
PostPaid
,PrePaid
. - auto_
renew bool - Whether to automatically renew in prepaid scenarios. Default is false.
- period int
- Purchase duration in prepaid scenarios. When PeriodUnit is specified as
Monthly
, the value range is 1-9. When PeriodUnit is specified asYearly
, the value range is 1-3. Default is 1. - period_
unit str - The purchase cycle in the prepaid scenario. Valid values:
Monthly
,Yearly
. Default isMonthly
.
- charge
Type String - The charge type of the rocketmq instance. Valid values:
PostPaid
,PrePaid
. - auto
Renew Boolean - Whether to automatically renew in prepaid scenarios. Default is false.
- period Number
- Purchase duration in prepaid scenarios. When PeriodUnit is specified as
Monthly
, the value range is 1-9. When PeriodUnit is specified asYearly
, the value range is 1-3. Default is 1. - period
Unit String - The purchase cycle in the prepaid scenario. Valid values:
Monthly
,Yearly
. Default isMonthly
.
RocketMQInstanceConnectionInfo, RocketMQInstanceConnectionInfoArgs
- Endpoint
Address stringIp - The endpoint address ip of the rocketmq.
- Endpoint
Type string - The endpoint type of the rocketmq.
- Internal
Endpoint string - The internal endpoint of the rocketmq.
- Network
Type string - The network type of the rocketmq.
- Public
Endpoint string - The public endpoint of the rocketmq.
- Endpoint
Address stringIp - The endpoint address ip of the rocketmq.
- Endpoint
Type string - The endpoint type of the rocketmq.
- Internal
Endpoint string - The internal endpoint of the rocketmq.
- Network
Type string - The network type of the rocketmq.
- Public
Endpoint string - The public endpoint of the rocketmq.
- endpoint
Address StringIp - The endpoint address ip of the rocketmq.
- endpoint
Type String - The endpoint type of the rocketmq.
- internal
Endpoint String - The internal endpoint of the rocketmq.
- network
Type String - The network type of the rocketmq.
- public
Endpoint String - The public endpoint of the rocketmq.
- endpoint
Address stringIp - The endpoint address ip of the rocketmq.
- endpoint
Type string - The endpoint type of the rocketmq.
- internal
Endpoint string - The internal endpoint of the rocketmq.
- network
Type string - The network type of the rocketmq.
- public
Endpoint string - The public endpoint of the rocketmq.
- endpoint_
address_ strip - The endpoint address ip of the rocketmq.
- endpoint_
type str - The endpoint type of the rocketmq.
- internal_
endpoint str - The internal endpoint of the rocketmq.
- network_
type str - The network type of the rocketmq.
- public_
endpoint str - The public endpoint of the rocketmq.
- endpoint
Address StringIp - The endpoint address ip of the rocketmq.
- endpoint
Type String - The endpoint type of the rocketmq.
- internal
Endpoint String - The internal endpoint of the rocketmq.
- network
Type String - The network type of the rocketmq.
- public
Endpoint String - The public endpoint of the rocketmq.
RocketMQInstanceTag, RocketMQInstanceTagArgs
Import
RocketmqInstance can be imported using the id, e.g.
$ pulumi import volcengine:rocketmq/rocketMQInstance:RocketMQInstance default resource_id
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.