Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. apig
  5. Gateway
Alibaba Cloud v3.72.0 published on Friday, Jan 3, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.apig.Gateway

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.72.0 published on Friday, Jan 3, 2025 by Pulumi
pulumi/pulumi-alicloud

    Import

    APIG Gateway can be imported using the id, e.g.

    $ pulumi import alicloud:apig/gateway:Gateway example <id>

    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,
            payment_type: Optional[str] = None,
            zone_config: Optional[GatewayZoneConfigArgs] = None,
            gateway_name: Optional[str] = None,
            log_config: Optional[GatewayLogConfigArgs] = None,
            network_access_config: Optional[GatewayNetworkAccessConfigArgs] = None,
            resource_group_id: Optional[str] = None,
            spec: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            vpc: Optional[GatewayVpcArgs] = None,
            vswitch: Optional[GatewayVswitchArgs] = 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:apig: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 gatewayResource = new AliCloud.Apig.Gateway("gatewayResource", new()
{
    PaymentType = "string",
    ZoneConfig = new AliCloud.Apig.Inputs.GatewayZoneConfigArgs
    {
        SelectOption = "string",
    },
    GatewayName = "string",
    LogConfig = new AliCloud.Apig.Inputs.GatewayLogConfigArgs
    {
        Sls = new AliCloud.Apig.Inputs.GatewayLogConfigSlsArgs
        {
            Enable = false,
        },
    },
    NetworkAccessConfig = new AliCloud.Apig.Inputs.GatewayNetworkAccessConfigArgs
    {
        Type = "string",
    },
    ResourceGroupId = "string",
    Spec = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Vpc = new AliCloud.Apig.Inputs.GatewayVpcArgs
    {
        VpcId = "string",
        Name = "string",
    },
    Vswitch = new AliCloud.Apig.Inputs.GatewayVswitchArgs
    {
        Name = "string",
        VswitchId = "string",
    },
});

    example, err := apig.NewGateway(ctx, "gatewayResource", &apig.GatewayArgs{
	PaymentType: pulumi.String("string"),
	ZoneConfig: &apig.GatewayZoneConfigArgs{
		SelectOption: pulumi.String("string"),
	},
	GatewayName: pulumi.String("string"),
	LogConfig: &apig.GatewayLogConfigArgs{
		Sls: &apig.GatewayLogConfigSlsArgs{
			Enable: pulumi.Bool(false),
		},
	},
	NetworkAccessConfig: &apig.GatewayNetworkAccessConfigArgs{
		Type: pulumi.String("string"),
	},
	ResourceGroupId: pulumi.String("string"),
	Spec:            pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Vpc: &apig.GatewayVpcArgs{
		VpcId: pulumi.String("string"),
		Name:  pulumi.String("string"),
	},
	Vswitch: &apig.GatewayVswitchArgs{
		Name:      pulumi.String("string"),
		VswitchId: pulumi.String("string"),
	},
})

    var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
    .paymentType("string")
    .zoneConfig(GatewayZoneConfigArgs.builder()
        .selectOption("string")
        .build())
    .gatewayName("string")
    .logConfig(GatewayLogConfigArgs.builder()
        .sls(GatewayLogConfigSlsArgs.builder()
            .enable(false)
            .build())
        .build())
    .networkAccessConfig(GatewayNetworkAccessConfigArgs.builder()
        .type("string")
        .build())
    .resourceGroupId("string")
    .spec("string")
    .tags(Map.of("string", "string"))
    .vpc(GatewayVpcArgs.builder()
        .vpcId("string")
        .name("string")
        .build())
    .vswitch(GatewayVswitchArgs.builder()
        .name("string")
        .vswitchId("string")
        .build())
    .build());

    gateway_resource = alicloud.apig.Gateway("gatewayResource",
    payment_type="string",
    zone_config={
        "select_option": "string",
    },
    gateway_name="string",
    log_config={
        "sls": {
            "enable": False,
        },
    },
    network_access_config={
        "type": "string",
    },
    resource_group_id="string",
    spec="string",
    tags={
        "string": "string",
    },
    vpc={
        "vpc_id": "string",
        "name": "string",
    },
    vswitch={
        "name": "string",
        "vswitch_id": "string",
    })

    const gatewayResource = new alicloud.apig.Gateway("gatewayResource", {
    paymentType: "string",
    zoneConfig: {
        selectOption: "string",
    },
    gatewayName: "string",
    logConfig: {
        sls: {
            enable: false,
        },
    },
    networkAccessConfig: {
        type: "string",
    },
    resourceGroupId: "string",
    spec: "string",
    tags: {
        string: "string",
    },
    vpc: {
        vpcId: "string",
        name: "string",
    },
    vswitch: {
        name: "string",
        vswitchId: "string",
    },
});

    type: alicloud:apig:Gateway
properties:
    gatewayName: string
    logConfig:
        sls:
            enable: false
    networkAccessConfig:
        type: string
    paymentType: string
    resourceGroupId: string
    spec: string
    tags:
        string: string
    vpc:
        name: string
        vpcId: string
    vswitch:
        name: string
        vswitchId: string
    zoneConfig:
        selectOption: 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:

    PaymentType string
    The payment type of the resource
    ZoneConfig Pulumi.AliCloud.Apig.Inputs.GatewayZoneConfig
    Availability Zone Configuration See zone_config below.
    GatewayName string
    The name of the resource
    LogConfig Pulumi.AliCloud.Apig.Inputs.GatewayLogConfig
    Log Configuration See log_config below.
    NetworkAccessConfig Pulumi.AliCloud.Apig.Inputs.GatewayNetworkAccessConfig
    Network Access Configuration See network_access_config below.
    ResourceGroupId string
    The ID of the resource group
    Spec string
    Gateway instance specifications
    Tags Dictionary<string, string>
    The tag of the resource
    Vpc Pulumi.AliCloud.Apig.Inputs.GatewayVpc
    The VPC associated with the Gateway. See vpc below.
    Vswitch Pulumi.AliCloud.Apig.Inputs.GatewayVswitch
    The virtual switch associated with the Gateway. See vswitch below.
    PaymentType string
    The payment type of the resource
    ZoneConfig GatewayZoneConfigArgs
    Availability Zone Configuration See zone_config below.
    GatewayName string
    The name of the resource
    LogConfig GatewayLogConfigArgs
    Log Configuration See log_config below.
    NetworkAccessConfig GatewayNetworkAccessConfigArgs
    Network Access Configuration See network_access_config below.
    ResourceGroupId string
    The ID of the resource group
    Spec string
    Gateway instance specifications
    Tags map[string]string
    The tag of the resource
    Vpc GatewayVpcArgs
    The VPC associated with the Gateway. See vpc below.
    Vswitch GatewayVswitchArgs
    The virtual switch associated with the Gateway. See vswitch below.
    paymentType String
    The payment type of the resource
    zoneConfig GatewayZoneConfig
    Availability Zone Configuration See zone_config below.
    gatewayName String
    The name of the resource
    logConfig GatewayLogConfig
    Log Configuration See log_config below.
    networkAccessConfig GatewayNetworkAccessConfig
    Network Access Configuration See network_access_config below.
    resourceGroupId String
    The ID of the resource group
    spec String
    Gateway instance specifications
    tags Map<String,String>
    The tag of the resource
    vpc GatewayVpc
    The VPC associated with the Gateway. See vpc below.
    vswitch GatewayVswitch
    The virtual switch associated with the Gateway. See vswitch below.
    paymentType string
    The payment type of the resource
    zoneConfig GatewayZoneConfig
    Availability Zone Configuration See zone_config below.
    gatewayName string
    The name of the resource
    logConfig GatewayLogConfig
    Log Configuration See log_config below.
    networkAccessConfig GatewayNetworkAccessConfig
    Network Access Configuration See network_access_config below.
    resourceGroupId string
    The ID of the resource group
    spec string
    Gateway instance specifications
    tags {[key: string]: string}
    The tag of the resource
    vpc GatewayVpc
    The VPC associated with the Gateway. See vpc below.
    vswitch GatewayVswitch
    The virtual switch associated with the Gateway. See vswitch below.
    payment_type str
    The payment type of the resource
    zone_config GatewayZoneConfigArgs
    Availability Zone Configuration See zone_config below.
    gateway_name str
    The name of the resource
    log_config GatewayLogConfigArgs
    Log Configuration See log_config below.
    network_access_config GatewayNetworkAccessConfigArgs
    Network Access Configuration See network_access_config below.
    resource_group_id str
    The ID of the resource group
    spec str
    Gateway instance specifications
    tags Mapping[str, str]
    The tag of the resource
    vpc GatewayVpcArgs
    The VPC associated with the Gateway. See vpc below.
    vswitch GatewayVswitchArgs
    The virtual switch associated with the Gateway. See vswitch below.
    paymentType String
    The payment type of the resource
    zoneConfig Property Map
    Availability Zone Configuration See zone_config below.
    gatewayName String
    The name of the resource
    logConfig Property Map
    Log Configuration See log_config below.
    networkAccessConfig Property Map
    Network Access Configuration See network_access_config below.
    resourceGroupId String
    The ID of the resource group
    spec String
    Gateway instance specifications
    tags Map<String>
    The tag of the resource
    vpc Property Map
    The VPC associated with the Gateway. See vpc below.
    vswitch Property Map
    The virtual switch associated with the Gateway. See vswitch below.

    Outputs

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

    CreateTime int
    The creation timestamp. Unit: milliseconds.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource
    CreateTime int
    The creation timestamp. Unit: milliseconds.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource
    createTime Integer
    The creation timestamp. Unit: milliseconds.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource
    createTime number
    The creation timestamp. Unit: milliseconds.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the resource
    create_time int
    The creation timestamp. Unit: milliseconds.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the resource
    createTime Number
    The creation timestamp. Unit: milliseconds.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource

    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,
        create_time: Optional[int] = None,
        gateway_name: Optional[str] = None,
        log_config: Optional[GatewayLogConfigArgs] = None,
        network_access_config: Optional[GatewayNetworkAccessConfigArgs] = None,
        payment_type: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        spec: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        vpc: Optional[GatewayVpcArgs] = None,
        vswitch: Optional[GatewayVswitchArgs] = None,
        zone_config: Optional[GatewayZoneConfigArgs] = 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:
    CreateTime int
    The creation timestamp. Unit: milliseconds.
    GatewayName string
    The name of the resource
    LogConfig Pulumi.AliCloud.Apig.Inputs.GatewayLogConfig
    Log Configuration See log_config below.
    NetworkAccessConfig Pulumi.AliCloud.Apig.Inputs.GatewayNetworkAccessConfig
    Network Access Configuration See network_access_config below.
    PaymentType string
    The payment type of the resource
    ResourceGroupId string
    The ID of the resource group
    Spec string
    Gateway instance specifications
    Status string
    The status of the resource
    Tags Dictionary<string, string>
    The tag of the resource
    Vpc Pulumi.AliCloud.Apig.Inputs.GatewayVpc
    The VPC associated with the Gateway. See vpc below.
    Vswitch Pulumi.AliCloud.Apig.Inputs.GatewayVswitch
    The virtual switch associated with the Gateway. See vswitch below.
    ZoneConfig Pulumi.AliCloud.Apig.Inputs.GatewayZoneConfig
    Availability Zone Configuration See zone_config below.
    CreateTime int
    The creation timestamp. Unit: milliseconds.
    GatewayName string
    The name of the resource
    LogConfig GatewayLogConfigArgs
    Log Configuration See log_config below.
    NetworkAccessConfig GatewayNetworkAccessConfigArgs
    Network Access Configuration See network_access_config below.
    PaymentType string
    The payment type of the resource
    ResourceGroupId string
    The ID of the resource group
    Spec string
    Gateway instance specifications
    Status string
    The status of the resource
    Tags map[string]string
    The tag of the resource
    Vpc GatewayVpcArgs
    The VPC associated with the Gateway. See vpc below.
    Vswitch GatewayVswitchArgs
    The virtual switch associated with the Gateway. See vswitch below.
    ZoneConfig GatewayZoneConfigArgs
    Availability Zone Configuration See zone_config below.
    createTime Integer
    The creation timestamp. Unit: milliseconds.
    gatewayName String
    The name of the resource
    logConfig GatewayLogConfig
    Log Configuration See log_config below.
    networkAccessConfig GatewayNetworkAccessConfig
    Network Access Configuration See network_access_config below.
    paymentType String
    The payment type of the resource
    resourceGroupId String
    The ID of the resource group
    spec String
    Gateway instance specifications
    status String
    The status of the resource
    tags Map<String,String>
    The tag of the resource
    vpc GatewayVpc
    The VPC associated with the Gateway. See vpc below.
    vswitch GatewayVswitch
    The virtual switch associated with the Gateway. See vswitch below.
    zoneConfig GatewayZoneConfig
    Availability Zone Configuration See zone_config below.
    createTime number
    The creation timestamp. Unit: milliseconds.
    gatewayName string
    The name of the resource
    logConfig GatewayLogConfig
    Log Configuration See log_config below.
    networkAccessConfig GatewayNetworkAccessConfig
    Network Access Configuration See network_access_config below.
    paymentType string
    The payment type of the resource
    resourceGroupId string
    The ID of the resource group
    spec string
    Gateway instance specifications
    status string
    The status of the resource
    tags {[key: string]: string}
    The tag of the resource
    vpc GatewayVpc
    The VPC associated with the Gateway. See vpc below.
    vswitch GatewayVswitch
    The virtual switch associated with the Gateway. See vswitch below.
    zoneConfig GatewayZoneConfig
    Availability Zone Configuration See zone_config below.
    create_time int
    The creation timestamp. Unit: milliseconds.
    gateway_name str
    The name of the resource
    log_config GatewayLogConfigArgs
    Log Configuration See log_config below.
    network_access_config GatewayNetworkAccessConfigArgs
    Network Access Configuration See network_access_config below.
    payment_type str
    The payment type of the resource
    resource_group_id str
    The ID of the resource group
    spec str
    Gateway instance specifications
    status str
    The status of the resource
    tags Mapping[str, str]
    The tag of the resource
    vpc GatewayVpcArgs
    The VPC associated with the Gateway. See vpc below.
    vswitch GatewayVswitchArgs
    The virtual switch associated with the Gateway. See vswitch below.
    zone_config GatewayZoneConfigArgs
    Availability Zone Configuration See zone_config below.
    createTime Number
    The creation timestamp. Unit: milliseconds.
    gatewayName String
    The name of the resource
    logConfig Property Map
    Log Configuration See log_config below.
    networkAccessConfig Property Map
    Network Access Configuration See network_access_config below.
    paymentType String
    The payment type of the resource
    resourceGroupId String
    The ID of the resource group
    spec String
    Gateway instance specifications
    status String
    The status of the resource
    tags Map<String>
    The tag of the resource
    vpc Property Map
    The VPC associated with the Gateway. See vpc below.
    vswitch Property Map
    The virtual switch associated with the Gateway. See vswitch below.
    zoneConfig Property Map
    Availability Zone Configuration See zone_config below.

    Supporting Types

    GatewayLogConfig, GatewayLogConfigArgs

    Sls GatewayLogConfigSls
    Sls See sls below.
    sls GatewayLogConfigSls
    Sls See sls below.
    sls GatewayLogConfigSls
    Sls See sls below.
    sls GatewayLogConfigSls
    Sls See sls below.
    sls Property Map
    Sls See sls below.

    GatewayLogConfigSls, GatewayLogConfigSlsArgs

    Enable bool
    Enable Log Service
    Enable bool
    Enable Log Service
    enable Boolean
    Enable Log Service
    enable boolean
    Enable Log Service
    enable bool
    Enable Log Service
    enable Boolean
    Enable Log Service

    GatewayNetworkAccessConfig, GatewayNetworkAccessConfigArgs

    Type string
    Network Access Type
    Type string
    Network Access Type
    type String
    Network Access Type
    type string
    Network Access Type
    type str
    Network Access Type
    type String
    Network Access Type

    GatewayVpc, GatewayVpcArgs

    VpcId string
    The VPC network ID.
    Name string
    The name of the VPC gateway.
    VpcId string
    The VPC network ID.
    Name string
    The name of the VPC gateway.
    vpcId String
    The VPC network ID.
    name String
    The name of the VPC gateway.
    vpcId string
    The VPC network ID.
    name string
    The name of the VPC gateway.
    vpc_id str
    The VPC network ID.
    name str
    The name of the VPC gateway.
    vpcId String
    The VPC network ID.
    name String
    The name of the VPC gateway.

    GatewayVswitch, GatewayVswitchArgs

    Name string
    The name of the VPC gateway.
    VswitchId string
    The ID of the virtual switch.
    Name string
    The name of the VPC gateway.
    VswitchId string
    The ID of the virtual switch.
    name String
    The name of the VPC gateway.
    vswitchId String
    The ID of the virtual switch.
    name string
    The name of the VPC gateway.
    vswitchId string
    The ID of the virtual switch.
    name str
    The name of the VPC gateway.
    vswitch_id str
    The ID of the virtual switch.
    name String
    The name of the VPC gateway.
    vswitchId String
    The ID of the virtual switch.

    GatewayZoneConfig, GatewayZoneConfigArgs

    SelectOption string
    Availability Zone Options
    SelectOption string
    Availability Zone Options
    selectOption String
    Availability Zone Options
    selectOption string
    Availability Zone Options
    select_option str
    Availability Zone Options
    selectOption String
    Availability Zone Options

    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.72.0 published on Friday, Jan 3, 2025 by Pulumi
    pulumi/pulumi-alicloud