1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. mse
  5. EngineNamespace
Alibaba Cloud v3.68.0 published on Monday, Dec 2, 2024 by Pulumi

alicloud.mse.EngineNamespace

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.68.0 published on Monday, Dec 2, 2024 by Pulumi

    Provides a Microservice Engine (MSE) Engine Namespace resource.

    For information about Microservice Engine (MSE) Engine Namespace and how to use it, see What is Engine Namespace.

    NOTE: Available since v1.166.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const example = alicloud.getZones({
        availableResourceCreation: "VSwitch",
    });
    const exampleNetwork = new alicloud.vpc.Network("example", {
        vpcName: "terraform-example",
        cidrBlock: "172.17.3.0/24",
    });
    const exampleSwitch = new alicloud.vpc.Switch("example", {
        vswitchName: "terraform-example",
        cidrBlock: "172.17.3.0/24",
        vpcId: exampleNetwork.id,
        zoneId: example.then(example => example.zones?.[0]?.id),
    });
    const exampleCluster = new alicloud.mse.Cluster("example", {
        clusterSpecification: "MSE_SC_1_2_60_c",
        clusterType: "Nacos-Ans",
        clusterVersion: "NACOS_2_0_0",
        instanceCount: 3,
        netType: "privatenet",
        pubNetworkFlow: "1",
        connectionType: "slb",
        clusterAliasName: "terraform-example",
        mseVersion: "mse_pro",
        vswitchId: exampleSwitch.id,
        vpcId: exampleNetwork.id,
    });
    const exampleEngineNamespace = new alicloud.mse.EngineNamespace("example", {
        instanceId: exampleCluster.id,
        namespaceShowName: "terraform-example",
        namespaceId: "terraform-example",
        namespaceDesc: "description",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.get_zones(available_resource_creation="VSwitch")
    example_network = alicloud.vpc.Network("example",
        vpc_name="terraform-example",
        cidr_block="172.17.3.0/24")
    example_switch = alicloud.vpc.Switch("example",
        vswitch_name="terraform-example",
        cidr_block="172.17.3.0/24",
        vpc_id=example_network.id,
        zone_id=example.zones[0].id)
    example_cluster = alicloud.mse.Cluster("example",
        cluster_specification="MSE_SC_1_2_60_c",
        cluster_type="Nacos-Ans",
        cluster_version="NACOS_2_0_0",
        instance_count=3,
        net_type="privatenet",
        pub_network_flow="1",
        connection_type="slb",
        cluster_alias_name="terraform-example",
        mse_version="mse_pro",
        vswitch_id=example_switch.id,
        vpc_id=example_network.id)
    example_engine_namespace = alicloud.mse.EngineNamespace("example",
        instance_id=example_cluster.id,
        namespace_show_name="terraform-example",
        namespace_id="terraform-example",
        namespace_desc="description")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/mse"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
    			AvailableResourceCreation: pulumi.StringRef("VSwitch"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
    			VpcName:   pulumi.String("terraform-example"),
    			CidrBlock: pulumi.String("172.17.3.0/24"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
    			VswitchName: pulumi.String("terraform-example"),
    			CidrBlock:   pulumi.String("172.17.3.0/24"),
    			VpcId:       exampleNetwork.ID(),
    			ZoneId:      pulumi.String(example.Zones[0].Id),
    		})
    		if err != nil {
    			return err
    		}
    		exampleCluster, err := mse.NewCluster(ctx, "example", &mse.ClusterArgs{
    			ClusterSpecification: pulumi.String("MSE_SC_1_2_60_c"),
    			ClusterType:          pulumi.String("Nacos-Ans"),
    			ClusterVersion:       pulumi.String("NACOS_2_0_0"),
    			InstanceCount:        pulumi.Int(3),
    			NetType:              pulumi.String("privatenet"),
    			PubNetworkFlow:       pulumi.String("1"),
    			ConnectionType:       pulumi.String("slb"),
    			ClusterAliasName:     pulumi.String("terraform-example"),
    			MseVersion:           pulumi.String("mse_pro"),
    			VswitchId:            exampleSwitch.ID(),
    			VpcId:                exampleNetwork.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = mse.NewEngineNamespace(ctx, "example", &mse.EngineNamespaceArgs{
    			InstanceId:        exampleCluster.ID(),
    			NamespaceShowName: pulumi.String("terraform-example"),
    			NamespaceId:       pulumi.String("terraform-example"),
    			NamespaceDesc:     pulumi.String("description"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = AliCloud.GetZones.Invoke(new()
        {
            AvailableResourceCreation = "VSwitch",
        });
    
        var exampleNetwork = new AliCloud.Vpc.Network("example", new()
        {
            VpcName = "terraform-example",
            CidrBlock = "172.17.3.0/24",
        });
    
        var exampleSwitch = new AliCloud.Vpc.Switch("example", new()
        {
            VswitchName = "terraform-example",
            CidrBlock = "172.17.3.0/24",
            VpcId = exampleNetwork.Id,
            ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        });
    
        var exampleCluster = new AliCloud.Mse.Cluster("example", new()
        {
            ClusterSpecification = "MSE_SC_1_2_60_c",
            ClusterType = "Nacos-Ans",
            ClusterVersion = "NACOS_2_0_0",
            InstanceCount = 3,
            NetType = "privatenet",
            PubNetworkFlow = "1",
            ConnectionType = "slb",
            ClusterAliasName = "terraform-example",
            MseVersion = "mse_pro",
            VswitchId = exampleSwitch.Id,
            VpcId = exampleNetwork.Id,
        });
    
        var exampleEngineNamespace = new AliCloud.Mse.EngineNamespace("example", new()
        {
            InstanceId = exampleCluster.Id,
            NamespaceShowName = "terraform-example",
            NamespaceId = "terraform-example",
            NamespaceDesc = "description",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.AlicloudFunctions;
    import com.pulumi.alicloud.inputs.GetZonesArgs;
    import com.pulumi.alicloud.vpc.Network;
    import com.pulumi.alicloud.vpc.NetworkArgs;
    import com.pulumi.alicloud.vpc.Switch;
    import com.pulumi.alicloud.vpc.SwitchArgs;
    import com.pulumi.alicloud.mse.Cluster;
    import com.pulumi.alicloud.mse.ClusterArgs;
    import com.pulumi.alicloud.mse.EngineNamespace;
    import com.pulumi.alicloud.mse.EngineNamespaceArgs;
    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 example = AlicloudFunctions.getZones(GetZonesArgs.builder()
                .availableResourceCreation("VSwitch")
                .build());
    
            var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
                .vpcName("terraform-example")
                .cidrBlock("172.17.3.0/24")
                .build());
    
            var exampleSwitch = new Switch("exampleSwitch", SwitchArgs.builder()
                .vswitchName("terraform-example")
                .cidrBlock("172.17.3.0/24")
                .vpcId(exampleNetwork.id())
                .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .build());
    
            var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
                .clusterSpecification("MSE_SC_1_2_60_c")
                .clusterType("Nacos-Ans")
                .clusterVersion("NACOS_2_0_0")
                .instanceCount(3)
                .netType("privatenet")
                .pubNetworkFlow("1")
                .connectionType("slb")
                .clusterAliasName("terraform-example")
                .mseVersion("mse_pro")
                .vswitchId(exampleSwitch.id())
                .vpcId(exampleNetwork.id())
                .build());
    
            var exampleEngineNamespace = new EngineNamespace("exampleEngineNamespace", EngineNamespaceArgs.builder()
                .instanceId(exampleCluster.id())
                .namespaceShowName("terraform-example")
                .namespaceId("terraform-example")
                .namespaceDesc("description")
                .build());
    
        }
    }
    
    resources:
      exampleNetwork:
        type: alicloud:vpc:Network
        name: example
        properties:
          vpcName: terraform-example
          cidrBlock: 172.17.3.0/24
      exampleSwitch:
        type: alicloud:vpc:Switch
        name: example
        properties:
          vswitchName: terraform-example
          cidrBlock: 172.17.3.0/24
          vpcId: ${exampleNetwork.id}
          zoneId: ${example.zones[0].id}
      exampleCluster:
        type: alicloud:mse:Cluster
        name: example
        properties:
          clusterSpecification: MSE_SC_1_2_60_c
          clusterType: Nacos-Ans
          clusterVersion: NACOS_2_0_0
          instanceCount: 3
          netType: privatenet
          pubNetworkFlow: '1'
          connectionType: slb
          clusterAliasName: terraform-example
          mseVersion: mse_pro
          vswitchId: ${exampleSwitch.id}
          vpcId: ${exampleNetwork.id}
      exampleEngineNamespace:
        type: alicloud:mse:EngineNamespace
        name: example
        properties:
          instanceId: ${exampleCluster.id}
          namespaceShowName: terraform-example
          namespaceId: terraform-example
          namespaceDesc: description
    variables:
      example:
        fn::invoke:
          Function: alicloud:getZones
          Arguments:
            availableResourceCreation: VSwitch
    

    Create EngineNamespace Resource

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

    Constructor syntax

    new EngineNamespace(name: string, args: EngineNamespaceArgs, opts?: CustomResourceOptions);
    @overload
    def EngineNamespace(resource_name: str,
                        args: EngineNamespaceArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def EngineNamespace(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        namespace_show_name: Optional[str] = None,
                        accept_language: Optional[str] = None,
                        cluster_id: Optional[str] = None,
                        instance_id: Optional[str] = None,
                        namespace_desc: Optional[str] = None,
                        namespace_id: Optional[str] = None)
    func NewEngineNamespace(ctx *Context, name string, args EngineNamespaceArgs, opts ...ResourceOption) (*EngineNamespace, error)
    public EngineNamespace(string name, EngineNamespaceArgs args, CustomResourceOptions? opts = null)
    public EngineNamespace(String name, EngineNamespaceArgs args)
    public EngineNamespace(String name, EngineNamespaceArgs args, CustomResourceOptions options)
    
    type: alicloud:mse:EngineNamespace
    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 EngineNamespaceArgs
    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 EngineNamespaceArgs
    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 EngineNamespaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EngineNamespaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EngineNamespaceArgs
    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 engineNamespaceResource = new AliCloud.Mse.EngineNamespace("engineNamespaceResource", new()
    {
        NamespaceShowName = "string",
        AcceptLanguage = "string",
        ClusterId = "string",
        InstanceId = "string",
        NamespaceDesc = "string",
        NamespaceId = "string",
    });
    
    example, err := mse.NewEngineNamespace(ctx, "engineNamespaceResource", &mse.EngineNamespaceArgs{
    	NamespaceShowName: pulumi.String("string"),
    	AcceptLanguage:    pulumi.String("string"),
    	ClusterId:         pulumi.String("string"),
    	InstanceId:        pulumi.String("string"),
    	NamespaceDesc:     pulumi.String("string"),
    	NamespaceId:       pulumi.String("string"),
    })
    
    var engineNamespaceResource = new EngineNamespace("engineNamespaceResource", EngineNamespaceArgs.builder()
        .namespaceShowName("string")
        .acceptLanguage("string")
        .clusterId("string")
        .instanceId("string")
        .namespaceDesc("string")
        .namespaceId("string")
        .build());
    
    engine_namespace_resource = alicloud.mse.EngineNamespace("engineNamespaceResource",
        namespace_show_name="string",
        accept_language="string",
        cluster_id="string",
        instance_id="string",
        namespace_desc="string",
        namespace_id="string")
    
    const engineNamespaceResource = new alicloud.mse.EngineNamespace("engineNamespaceResource", {
        namespaceShowName: "string",
        acceptLanguage: "string",
        clusterId: "string",
        instanceId: "string",
        namespaceDesc: "string",
        namespaceId: "string",
    });
    
    type: alicloud:mse:EngineNamespace
    properties:
        acceptLanguage: string
        clusterId: string
        instanceId: string
        namespaceDesc: string
        namespaceId: string
        namespaceShowName: string
    

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

    NamespaceShowName string
    The name of the Engine Namespace.
    AcceptLanguage string
    The language type of the returned information. Valid values: zh, en.
    ClusterId string
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    InstanceId string
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    NamespaceDesc string

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    NamespaceId string
    The id of Namespace.
    NamespaceShowName string
    The name of the Engine Namespace.
    AcceptLanguage string
    The language type of the returned information. Valid values: zh, en.
    ClusterId string
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    InstanceId string
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    NamespaceDesc string

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    NamespaceId string
    The id of Namespace.
    namespaceShowName String
    The name of the Engine Namespace.
    acceptLanguage String
    The language type of the returned information. Valid values: zh, en.
    clusterId String
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    instanceId String
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    namespaceDesc String

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    namespaceId String
    The id of Namespace.
    namespaceShowName string
    The name of the Engine Namespace.
    acceptLanguage string
    The language type of the returned information. Valid values: zh, en.
    clusterId string
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    instanceId string
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    namespaceDesc string

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    namespaceId string
    The id of Namespace.
    namespace_show_name str
    The name of the Engine Namespace.
    accept_language str
    The language type of the returned information. Valid values: zh, en.
    cluster_id str
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    instance_id str
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    namespace_desc str

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    namespace_id str
    The id of Namespace.
    namespaceShowName String
    The name of the Engine Namespace.
    acceptLanguage String
    The language type of the returned information. Valid values: zh, en.
    clusterId String
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    instanceId String
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    namespaceDesc String

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    namespaceId String
    The id of Namespace.

    Outputs

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

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

    Look up Existing EngineNamespace Resource

    Get an existing EngineNamespace 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?: EngineNamespaceState, opts?: CustomResourceOptions): EngineNamespace
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accept_language: Optional[str] = None,
            cluster_id: Optional[str] = None,
            instance_id: Optional[str] = None,
            namespace_desc: Optional[str] = None,
            namespace_id: Optional[str] = None,
            namespace_show_name: Optional[str] = None) -> EngineNamespace
    func GetEngineNamespace(ctx *Context, name string, id IDInput, state *EngineNamespaceState, opts ...ResourceOption) (*EngineNamespace, error)
    public static EngineNamespace Get(string name, Input<string> id, EngineNamespaceState? state, CustomResourceOptions? opts = null)
    public static EngineNamespace get(String name, Output<String> id, EngineNamespaceState 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:
    AcceptLanguage string
    The language type of the returned information. Valid values: zh, en.
    ClusterId string
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    InstanceId string
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    NamespaceDesc string

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    NamespaceId string
    The id of Namespace.
    NamespaceShowName string
    The name of the Engine Namespace.
    AcceptLanguage string
    The language type of the returned information. Valid values: zh, en.
    ClusterId string
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    InstanceId string
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    NamespaceDesc string

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    NamespaceId string
    The id of Namespace.
    NamespaceShowName string
    The name of the Engine Namespace.
    acceptLanguage String
    The language type of the returned information. Valid values: zh, en.
    clusterId String
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    instanceId String
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    namespaceDesc String

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    namespaceId String
    The id of Namespace.
    namespaceShowName String
    The name of the Engine Namespace.
    acceptLanguage string
    The language type of the returned information. Valid values: zh, en.
    clusterId string
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    instanceId string
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    namespaceDesc string

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    namespaceId string
    The id of Namespace.
    namespaceShowName string
    The name of the Engine Namespace.
    accept_language str
    The language type of the returned information. Valid values: zh, en.
    cluster_id str
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    instance_id str
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    namespace_desc str

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    namespace_id str
    The id of Namespace.
    namespace_show_name str
    The name of the Engine Namespace.
    acceptLanguage String
    The language type of the returned information. Valid values: zh, en.
    clusterId String
    The id of the cluster.It is formatted to mse-xxxxxxxx.
    instanceId String
    The instance id of the cluster. It is formatted to mse-cn-xxxxxxxxxxx.Available since v1.232.0.
    namespaceDesc String

    The description of the namespace.

    NOTE: You must set cluster_id or instance_id or both.

    namespaceId String
    The id of Namespace.
    namespaceShowName String
    The name of the Engine Namespace.

    Import

    Microservice Engine (MSE) Engine Namespace can be imported using the id, e.g.

    $ pulumi import alicloud:mse/engineNamespace:EngineNamespace example <instance_id>:<namespace_id>
    

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.68.0 published on Monday, Dec 2, 2024 by Pulumi