Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

Instance

Provides an ONS instance resource.

For more information about how to use it, see RocketMQ Instance Management API.

NOTE: The number of instances in the same region cannot exceed 8. At present, the resource does not support region “mq-internet-access” and “ap-southeast-5”.

NOTE: Available in 1.51.0+

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new AliCloud.RocketMQ.Instance("example", new AliCloud.RocketMQ.InstanceArgs
        {
            InstanceName = "tf-example-ons-instance",
            Remark = "tf-example-ons-instance-remark",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rocketmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rocketmq.NewInstance(ctx, "example", &rocketmq.InstanceArgs{
			InstanceName: pulumi.String("tf-example-ons-instance"),
			Remark:       pulumi.String("tf-example-ons-instance-remark"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.rocketmq.Instance;
import com.pulumi.alicloud.rocketmq.InstanceArgs;
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) {
        var example = new Instance("example", InstanceArgs.builder()        
            .instanceName("tf-example-ons-instance")
            .remark("tf-example-ons-instance-remark")
            .build());

    }
}
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.rocketmq.Instance("example",
    instance_name="tf-example-ons-instance",
    remark="tf-example-ons-instance-remark")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.rocketmq.Instance("example", {
    instanceName: "tf-example-ons-instance",
    remark: "tf-example-ons-instance-remark",
});
resources:
  example:
    type: alicloud:rocketmq:Instance
    properties:
      instanceName: tf-example-ons-instance
      remark: tf-example-ons-instance-remark

Create a Instance Resource

new Instance(name: string, args?: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             instance_name: Optional[str] = None,
             name: Optional[str] = None,
             remark: Optional[str] = None,
             tags: Optional[Mapping[str, Any]] = None)
@overload
def Instance(resource_name: str,
             args: Optional[InstanceArgs] = None,
             opts: Optional[ResourceOptions] = None)
func NewInstance(ctx *Context, name string, args *InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs? args = null, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: alicloud:rocketmq:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args InstanceArgs
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 InstanceArgs
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 InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Instance resource accepts the following input properties:

InstanceName string

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

Name string

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

Remark string

This attribute is a concise description of instance. The length cannot exceed 128.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
InstanceName string

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

Name string

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

Remark string

This attribute is a concise description of instance. The length cannot exceed 128.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
instanceName String

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

name String

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

remark String

This attribute is a concise description of instance. The length cannot exceed 128.

tags Map<String,Object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
instanceName string

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

name string

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

remark string

This attribute is a concise description of instance. The length cannot exceed 128.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
instance_name str

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

name str

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

remark str

This attribute is a concise description of instance. The length cannot exceed 128.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
instanceName String

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

name String

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

remark String

This attribute is a concise description of instance. The length cannot exceed 128.

tags Map<Any>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

InstanceStatus int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

InstanceType int

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

ReleaseTime string

Platinum edition instance expiration time.

Status int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

Id string

The provider-assigned unique ID for this managed resource.

InstanceStatus int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

InstanceType int

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

ReleaseTime string

Platinum edition instance expiration time.

Status int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

id String

The provider-assigned unique ID for this managed resource.

instanceStatus Integer

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instanceType Integer

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

releaseTime String

Platinum edition instance expiration time.

status Integer

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

id string

The provider-assigned unique ID for this managed resource.

instanceStatus number

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instanceType number

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

releaseTime string

Platinum edition instance expiration time.

status number

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

id str

The provider-assigned unique ID for this managed resource.

instance_status int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instance_type int

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

release_time str

Platinum edition instance expiration time.

status int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

id String

The provider-assigned unique ID for this managed resource.

instanceStatus Number

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instanceType Number

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

releaseTime String

Platinum edition instance expiration time.

status Number

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

Look up an Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[int] = None,
        instance_type: Optional[int] = None,
        name: Optional[str] = None,
        release_time: Optional[str] = None,
        remark: Optional[str] = None,
        status: Optional[int] = None,
        tags: Optional[Mapping[str, Any]] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
InstanceName string

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

InstanceStatus int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

InstanceType int

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

Name string

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

ReleaseTime string

Platinum edition instance expiration time.

Remark string

This attribute is a concise description of instance. The length cannot exceed 128.

Status int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
InstanceName string

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

InstanceStatus int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

InstanceType int

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

Name string

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

ReleaseTime string

Platinum edition instance expiration time.

Remark string

This attribute is a concise description of instance. The length cannot exceed 128.

Status int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
instanceName String

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

instanceStatus Integer

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instanceType Integer

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

name String

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

releaseTime String

Platinum edition instance expiration time.

remark String

This attribute is a concise description of instance. The length cannot exceed 128.

status Integer

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

tags Map<String,Object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
instanceName string

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

instanceStatus number

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instanceType number

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

name string

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

releaseTime string

Platinum edition instance expiration time.

remark string

This attribute is a concise description of instance. The length cannot exceed 128.

status number

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
instance_name str

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

instance_status int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instance_type int

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

name str

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

release_time str

Platinum edition instance expiration time.

remark str

This attribute is a concise description of instance. The length cannot exceed 128.

status int

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
instanceName String

Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

instanceStatus Number

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instanceType Number

The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

name String

Replaced by instance_name after version 1.97.0.

Deprecated:

Field 'name' has been deprecated from version 1.97.0. Use 'instance_name' instead.

releaseTime String

Platinum edition instance expiration time.

remark String

This attribute is a concise description of instance. The length cannot exceed 128.

status Number

The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

tags Map<Any>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

Import

ONS INSTANCE can be imported using the id, e.g.

 $ pulumi import alicloud:rocketmq/instance:Instance instance MQ_INST_1234567890_Baso1234567

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.