Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. apigateway
  5. Backend
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.apigateway.Backend

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a Api Gateway Backend resource.

For information about Api Gateway Backend and how to use it, see What is Backend.

NOTE: Available since v1.181.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "tf_example";
const _default = new alicloud.apigateway.Backend("default", {
    backendName: name,
    description: name,
    backendType: "HTTP",
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf_example"
default = alicloud.apigateway.Backend("default",
    backend_name=name,
    description=name,
    backend_type="HTTP")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "tf_example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_, err := apigateway.NewBackend(ctx, "default", &apigateway.BackendArgs{
			BackendName: pulumi.String(name),
			Description: pulumi.String(name),
			BackendType: pulumi.String("HTTP"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "tf_example";
    var @default = new AliCloud.ApiGateway.Backend("default", new()
    {
        BackendName = name,
        Description = name,
        BackendType = "HTTP",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.Backend;
import com.pulumi.alicloud.apigateway.BackendArgs;
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 config = ctx.config();
        final var name = config.get("name").orElse("tf_example");
        var default_ = new Backend("default", BackendArgs.builder()
            .backendName(name)
            .description(name)
            .backendType("HTTP")
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: tf_example
resources:
  default:
    type: alicloud:apigateway:Backend
    properties:
      backendName: ${name}
      description: ${name}
      backendType: HTTP
Copy

Create Backend Resource

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

Constructor syntax

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

@overload
def Backend(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            backend_name: Optional[str] = None,
            backend_type: Optional[str] = None,
            create_event_bridge_service_linked_role: Optional[bool] = None,
            description: Optional[str] = None)
func NewBackend(ctx *Context, name string, args BackendArgs, opts ...ResourceOption) (*Backend, error)
public Backend(string name, BackendArgs args, CustomResourceOptions? opts = null)
public Backend(String name, BackendArgs args)
public Backend(String name, BackendArgs args, CustomResourceOptions options)

type: alicloud:apigateway:Backend
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BackendArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BackendArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackendArgs
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 backendResource = new AliCloud.ApiGateway.Backend("backendResource", new()
{
    BackendName = "string",
    BackendType = "string",
    CreateEventBridgeServiceLinkedRole = false,
    Description = "string",
});
Copy
example, err := apigateway.NewBackend(ctx, "backendResource", &apigateway.BackendArgs{
	BackendName:                        pulumi.String("string"),
	BackendType:                        pulumi.String("string"),
	CreateEventBridgeServiceLinkedRole: pulumi.Bool(false),
	Description:                        pulumi.String("string"),
})
Copy
var backendResource = new Backend("backendResource", BackendArgs.builder()
    .backendName("string")
    .backendType("string")
    .createEventBridgeServiceLinkedRole(false)
    .description("string")
    .build());
Copy
backend_resource = alicloud.apigateway.Backend("backendResource",
    backend_name="string",
    backend_type="string",
    create_event_bridge_service_linked_role=False,
    description="string")
Copy
const backendResource = new alicloud.apigateway.Backend("backendResource", {
    backendName: "string",
    backendType: "string",
    createEventBridgeServiceLinkedRole: false,
    description: "string",
});
Copy
type: alicloud:apigateway:Backend
properties:
    backendName: string
    backendType: string
    createEventBridgeServiceLinkedRole: false
    description: string
Copy

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

BackendName This property is required. string
The name of the Backend.
BackendType
This property is required.
Changes to this property will trigger replacement.
string
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
CreateEventBridgeServiceLinkedRole Changes to this property will trigger replacement. bool
Whether to create an Event bus service association role.
Description string
The description of the Backend.
BackendName This property is required. string
The name of the Backend.
BackendType
This property is required.
Changes to this property will trigger replacement.
string
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
CreateEventBridgeServiceLinkedRole Changes to this property will trigger replacement. bool
Whether to create an Event bus service association role.
Description string
The description of the Backend.
backendName This property is required. String
The name of the Backend.
backendType
This property is required.
Changes to this property will trigger replacement.
String
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
createEventBridgeServiceLinkedRole Changes to this property will trigger replacement. Boolean
Whether to create an Event bus service association role.
description String
The description of the Backend.
backendName This property is required. string
The name of the Backend.
backendType
This property is required.
Changes to this property will trigger replacement.
string
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
createEventBridgeServiceLinkedRole Changes to this property will trigger replacement. boolean
Whether to create an Event bus service association role.
description string
The description of the Backend.
backend_name This property is required. str
The name of the Backend.
backend_type
This property is required.
Changes to this property will trigger replacement.
str
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
create_event_bridge_service_linked_role Changes to this property will trigger replacement. bool
Whether to create an Event bus service association role.
description str
The description of the Backend.
backendName This property is required. String
The name of the Backend.
backendType
This property is required.
Changes to this property will trigger replacement.
String
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
createEventBridgeServiceLinkedRole Changes to this property will trigger replacement. Boolean
Whether to create an Event bus service association role.
description String
The description of the Backend.

Outputs

All input properties are implicitly available as output properties. Additionally, the Backend 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 Backend Resource

Get an existing Backend 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?: BackendState, opts?: CustomResourceOptions): Backend
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend_name: Optional[str] = None,
        backend_type: Optional[str] = None,
        create_event_bridge_service_linked_role: Optional[bool] = None,
        description: Optional[str] = None) -> Backend
func GetBackend(ctx *Context, name string, id IDInput, state *BackendState, opts ...ResourceOption) (*Backend, error)
public static Backend Get(string name, Input<string> id, BackendState? state, CustomResourceOptions? opts = null)
public static Backend get(String name, Output<String> id, BackendState state, CustomResourceOptions options)
resources:  _:    type: alicloud:apigateway:Backend    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
BackendName string
The name of the Backend.
BackendType Changes to this property will trigger replacement. string
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
CreateEventBridgeServiceLinkedRole Changes to this property will trigger replacement. bool
Whether to create an Event bus service association role.
Description string
The description of the Backend.
BackendName string
The name of the Backend.
BackendType Changes to this property will trigger replacement. string
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
CreateEventBridgeServiceLinkedRole Changes to this property will trigger replacement. bool
Whether to create an Event bus service association role.
Description string
The description of the Backend.
backendName String
The name of the Backend.
backendType Changes to this property will trigger replacement. String
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
createEventBridgeServiceLinkedRole Changes to this property will trigger replacement. Boolean
Whether to create an Event bus service association role.
description String
The description of the Backend.
backendName string
The name of the Backend.
backendType Changes to this property will trigger replacement. string
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
createEventBridgeServiceLinkedRole Changes to this property will trigger replacement. boolean
Whether to create an Event bus service association role.
description string
The description of the Backend.
backend_name str
The name of the Backend.
backend_type Changes to this property will trigger replacement. str
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
create_event_bridge_service_linked_role Changes to this property will trigger replacement. bool
Whether to create an Event bus service association role.
description str
The description of the Backend.
backendName String
The name of the Backend.
backendType Changes to this property will trigger replacement. String
The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.
createEventBridgeServiceLinkedRole Changes to this property will trigger replacement. Boolean
Whether to create an Event bus service association role.
description String
The description of the Backend.

Import

Api Gateway Backend can be imported using the id, e.g.

$ pulumi import alicloud:apigateway/backend:Backend example <id>
Copy

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.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud