Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. mse
  5. Gateway
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.mse.Gateway

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a Microservice Engine (MSE) Gateway resource.

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

    NOTE: Available in v1.157.0+.

    Create Gateway Resource

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

    Constructor syntax

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

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            replica: Optional[int] = None,
            spec: Optional[str] = None,
            vpc_id: Optional[str] = None,
            vswitch_id: Optional[str] = None,
            backup_vswitch_id: Optional[str] = None,
            delete_slb: Optional[bool] = None,
            enterprise_security_group: Optional[bool] = None,
            gateway_name: Optional[str] = None,
            internet_slb_spec: Optional[str] = None,
            slb_spec: Optional[str] = None)
    func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
    public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
    public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

    type: alicloud:mse:Gateway
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 GatewayArgs
    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 GatewayArgs
    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 GatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayArgs
    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 examplegatewayResourceResourceFromMsegateway = new AliCloud.Mse.Gateway("examplegatewayResourceResourceFromMsegateway", new()
{
    Replica = 0,
    Spec = "string",
    VpcId = "string",
    VswitchId = "string",
    BackupVswitchId = "string",
    DeleteSlb = false,
    EnterpriseSecurityGroup = false,
    GatewayName = "string",
    InternetSlbSpec = "string",
    SlbSpec = "string",
});

    example, err := mse.NewGateway(ctx, "examplegatewayResourceResourceFromMsegateway", &mse.GatewayArgs{
	Replica:                 pulumi.Int(0),
	Spec:                    pulumi.String("string"),
	VpcId:                   pulumi.String("string"),
	VswitchId:               pulumi.String("string"),
	BackupVswitchId:         pulumi.String("string"),
	DeleteSlb:               pulumi.Bool(false),
	EnterpriseSecurityGroup: pulumi.Bool(false),
	GatewayName:             pulumi.String("string"),
	InternetSlbSpec:         pulumi.String("string"),
	SlbSpec:                 pulumi.String("string"),
})

    var examplegatewayResourceResourceFromMsegateway = new Gateway("examplegatewayResourceResourceFromMsegateway", GatewayArgs.builder()
    .replica(0)
    .spec("string")
    .vpcId("string")
    .vswitchId("string")
    .backupVswitchId("string")
    .deleteSlb(false)
    .enterpriseSecurityGroup(false)
    .gatewayName("string")
    .internetSlbSpec("string")
    .slbSpec("string")
    .build());

    examplegateway_resource_resource_from_msegateway = alicloud.mse.Gateway("examplegatewayResourceResourceFromMsegateway",
    replica=0,
    spec="string",
    vpc_id="string",
    vswitch_id="string",
    backup_vswitch_id="string",
    delete_slb=False,
    enterprise_security_group=False,
    gateway_name="string",
    internet_slb_spec="string",
    slb_spec="string")

    const examplegatewayResourceResourceFromMsegateway = new alicloud.mse.Gateway("examplegatewayResourceResourceFromMsegateway", {
    replica: 0,
    spec: "string",
    vpcId: "string",
    vswitchId: "string",
    backupVswitchId: "string",
    deleteSlb: false,
    enterpriseSecurityGroup: false,
    gatewayName: "string",
    internetSlbSpec: "string",
    slbSpec: "string",
});

    type: alicloud:mse:Gateway
properties:
    backupVswitchId: string
    deleteSlb: false
    enterpriseSecurityGroup: false
    gatewayName: string
    internetSlbSpec: string
    replica: 0
    slbSpec: string
    spec: string
    vpcId: string
    vswitchId: string

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

    Replica int
    Number of Gateway Nodes.
    Spec string
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    VpcId string
    The ID of the vpc.
    VswitchId string
    The ID of the vswitch.
    BackupVswitchId string
    The backup vswitch id.
    DeleteSlb bool
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    EnterpriseSecurityGroup bool
    Whether the enterprise security group type.
    GatewayName string
    The name of the Gateway .
    InternetSlbSpec string
    Public network SLB specifications.
    SlbSpec string
    Private network SLB specifications.
    Replica int
    Number of Gateway Nodes.
    Spec string
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    VpcId string
    The ID of the vpc.
    VswitchId string
    The ID of the vswitch.
    BackupVswitchId string
    The backup vswitch id.
    DeleteSlb bool
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    EnterpriseSecurityGroup bool
    Whether the enterprise security group type.
    GatewayName string
    The name of the Gateway .
    InternetSlbSpec string
    Public network SLB specifications.
    SlbSpec string
    Private network SLB specifications.
    replica Integer
    Number of Gateway Nodes.
    spec String
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    vpcId String
    The ID of the vpc.
    vswitchId String
    The ID of the vswitch.
    backupVswitchId String
    The backup vswitch id.
    deleteSlb Boolean
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    enterpriseSecurityGroup Boolean
    Whether the enterprise security group type.
    gatewayName String
    The name of the Gateway .
    internetSlbSpec String
    Public network SLB specifications.
    slbSpec String
    Private network SLB specifications.
    replica number
    Number of Gateway Nodes.
    spec string
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    vpcId string
    The ID of the vpc.
    vswitchId string
    The ID of the vswitch.
    backupVswitchId string
    The backup vswitch id.
    deleteSlb boolean
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    enterpriseSecurityGroup boolean
    Whether the enterprise security group type.
    gatewayName string
    The name of the Gateway .
    internetSlbSpec string
    Public network SLB specifications.
    slbSpec string
    Private network SLB specifications.
    replica int
    Number of Gateway Nodes.
    spec str
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    vpc_id str
    The ID of the vpc.
    vswitch_id str
    The ID of the vswitch.
    backup_vswitch_id str
    The backup vswitch id.
    delete_slb bool
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    enterprise_security_group bool
    Whether the enterprise security group type.
    gateway_name str
    The name of the Gateway .
    internet_slb_spec str
    Public network SLB specifications.
    slb_spec str
    Private network SLB specifications.
    replica Number
    Number of Gateway Nodes.
    spec String
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    vpcId String
    The ID of the vpc.
    vswitchId String
    The ID of the vswitch.
    backupVswitchId String
    The backup vswitch id.
    deleteSlb Boolean
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    enterpriseSecurityGroup Boolean
    Whether the enterprise security group type.
    gatewayName String
    The name of the Gateway .
    internetSlbSpec String
    Public network SLB specifications.
    slbSpec String
    Private network SLB specifications.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SlbLists List<Pulumi.AliCloud.Mse.Outputs.GatewaySlbList>
    A list of gateway Slb.
    Status string
    The status of the gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    SlbLists []GatewaySlbList
    A list of gateway Slb.
    Status string
    The status of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    slbLists List<GatewaySlbList>
    A list of gateway Slb.
    status String
    The status of the gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    slbLists GatewaySlbList[]
    A list of gateway Slb.
    status string
    The status of the gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    slb_lists Sequence[GatewaySlbList]
    A list of gateway Slb.
    status str
    The status of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    slbLists List<Property Map>
    A list of gateway Slb.
    status String
    The status of the gateway.

    Look up Existing Gateway Resource

    Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_vswitch_id: Optional[str] = None,
        delete_slb: Optional[bool] = None,
        enterprise_security_group: Optional[bool] = None,
        gateway_name: Optional[str] = None,
        internet_slb_spec: Optional[str] = None,
        replica: Optional[int] = None,
        slb_lists: Optional[Sequence[GatewaySlbListArgs]] = None,
        slb_spec: Optional[str] = None,
        spec: Optional[str] = None,
        status: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None) -> Gateway
    func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
    public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
    public static Gateway get(String name, Output<String> id, GatewayState 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:
    BackupVswitchId string
    The backup vswitch id.
    DeleteSlb bool
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    EnterpriseSecurityGroup bool
    Whether the enterprise security group type.
    GatewayName string
    The name of the Gateway .
    InternetSlbSpec string
    Public network SLB specifications.
    Replica int
    Number of Gateway Nodes.
    SlbLists List<Pulumi.AliCloud.Mse.Inputs.GatewaySlbList>
    A list of gateway Slb.
    SlbSpec string
    Private network SLB specifications.
    Spec string
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    Status string
    The status of the gateway.
    VpcId string
    The ID of the vpc.
    VswitchId string
    The ID of the vswitch.
    BackupVswitchId string
    The backup vswitch id.
    DeleteSlb bool
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    EnterpriseSecurityGroup bool
    Whether the enterprise security group type.
    GatewayName string
    The name of the Gateway .
    InternetSlbSpec string
    Public network SLB specifications.
    Replica int
    Number of Gateway Nodes.
    SlbLists []GatewaySlbListArgs
    A list of gateway Slb.
    SlbSpec string
    Private network SLB specifications.
    Spec string
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    Status string
    The status of the gateway.
    VpcId string
    The ID of the vpc.
    VswitchId string
    The ID of the vswitch.
    backupVswitchId String
    The backup vswitch id.
    deleteSlb Boolean
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    enterpriseSecurityGroup Boolean
    Whether the enterprise security group type.
    gatewayName String
    The name of the Gateway .
    internetSlbSpec String
    Public network SLB specifications.
    replica Integer
    Number of Gateway Nodes.
    slbLists List<GatewaySlbList>
    A list of gateway Slb.
    slbSpec String
    Private network SLB specifications.
    spec String
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    status String
    The status of the gateway.
    vpcId String
    The ID of the vpc.
    vswitchId String
    The ID of the vswitch.
    backupVswitchId string
    The backup vswitch id.
    deleteSlb boolean
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    enterpriseSecurityGroup boolean
    Whether the enterprise security group type.
    gatewayName string
    The name of the Gateway .
    internetSlbSpec string
    Public network SLB specifications.
    replica number
    Number of Gateway Nodes.
    slbLists GatewaySlbList[]
    A list of gateway Slb.
    slbSpec string
    Private network SLB specifications.
    spec string
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    status string
    The status of the gateway.
    vpcId string
    The ID of the vpc.
    vswitchId string
    The ID of the vswitch.
    backup_vswitch_id str
    The backup vswitch id.
    delete_slb bool
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    enterprise_security_group bool
    Whether the enterprise security group type.
    gateway_name str
    The name of the Gateway .
    internet_slb_spec str
    Public network SLB specifications.
    replica int
    Number of Gateway Nodes.
    slb_lists Sequence[GatewaySlbListArgs]
    A list of gateway Slb.
    slb_spec str
    Private network SLB specifications.
    spec str
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    status str
    The status of the gateway.
    vpc_id str
    The ID of the vpc.
    vswitch_id str
    The ID of the vswitch.
    backupVswitchId String
    The backup vswitch id.
    deleteSlb Boolean
    Whether to delete the SLB purchased on behalf of the gateway at the same time.
    enterpriseSecurityGroup Boolean
    Whether the enterprise security group type.
    gatewayName String
    The name of the Gateway .
    internetSlbSpec String
    Public network SLB specifications.
    replica Number
    Number of Gateway Nodes.
    slbLists List<Property Map>
    A list of gateway Slb.
    slbSpec String
    Private network SLB specifications.
    spec String
    Gateway Node Specifications. Valid values: MSE_GTW_2_4_200_c, MSE_GTW_4_8_200_c, MSE_GTW_8_16_200_c, MSE_GTW_16_32_200_c.
    status String
    The status of the gateway.
    vpcId String
    The ID of the vpc.
    vswitchId String
    The ID of the vswitch.

    Supporting Types

    GatewaySlbList, GatewaySlbListArgs

    AssociateId string
    The associate id.
    GatewaySlbMode string
    The Mode of the gateway slb.
    GatewaySlbStatus string
    The Status of the gateway slb.
    GmtCreate string
    The creation time of the gateway slb.
    SlbId string
    The ID of the gateway slb.
    SlbIp string
    The ip of the gateway slb.
    SlbPort string
    The port of the gateway slb.
    Type string
    The type of the gateway slb.
    AssociateId string
    The associate id.
    GatewaySlbMode string
    The Mode of the gateway slb.
    GatewaySlbStatus string
    The Status of the gateway slb.
    GmtCreate string
    The creation time of the gateway slb.
    SlbId string
    The ID of the gateway slb.
    SlbIp string
    The ip of the gateway slb.
    SlbPort string
    The port of the gateway slb.
    Type string
    The type of the gateway slb.
    associateId String
    The associate id.
    gatewaySlbMode String
    The Mode of the gateway slb.
    gatewaySlbStatus String
    The Status of the gateway slb.
    gmtCreate String
    The creation time of the gateway slb.
    slbId String
    The ID of the gateway slb.
    slbIp String
    The ip of the gateway slb.
    slbPort String
    The port of the gateway slb.
    type String
    The type of the gateway slb.
    associateId string
    The associate id.
    gatewaySlbMode string
    The Mode of the gateway slb.
    gatewaySlbStatus string
    The Status of the gateway slb.
    gmtCreate string
    The creation time of the gateway slb.
    slbId string
    The ID of the gateway slb.
    slbIp string
    The ip of the gateway slb.
    slbPort string
    The port of the gateway slb.
    type string
    The type of the gateway slb.
    associate_id str
    The associate id.
    gateway_slb_mode str
    The Mode of the gateway slb.
    gateway_slb_status str
    The Status of the gateway slb.
    gmt_create str
    The creation time of the gateway slb.
    slb_id str
    The ID of the gateway slb.
    slb_ip str
    The ip of the gateway slb.
    slb_port str
    The port of the gateway slb.
    type str
    The type of the gateway slb.
    associateId String
    The associate id.
    gatewaySlbMode String
    The Mode of the gateway slb.
    gatewaySlbStatus String
    The Status of the gateway slb.
    gmtCreate String
    The creation time of the gateway slb.
    slbId String
    The ID of the gateway slb.
    slbIp String
    The ip of the gateway slb.
    slbPort String
    The port of the gateway slb.
    type String
    The type of the gateway slb.

    Import

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

    $ pulumi import alicloud:mse/gateway:Gateway example <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.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud