Docs Packages
  1. Pulumi Registry
  2. Alibaba Cloud
  3. API Docs
  4. apigateway
  5. Backend
alicloud logo
Alibaba Cloud v3.37.0, May 15 23

alicloud.apigateway.Backend

Explore with Pulumi AI

Provides a Api Gateway Backend resource.

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

NOTE: Available in v1.181.0+.

Example Usage

Basic Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

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

});

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, "")
		name1 := "tf-testAccBackend"
		if param := cfg.Get("name1"); param != "" {
			name1 = param
		}
		_, err := apigateway.NewBackend(ctx, "default", &apigateway.BackendArgs{
			BackendName: pulumi.Any(_var.Name),
			Description: pulumi.Any(_var.Name),
			BackendType: pulumi.String("HTTP"),
		})
		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.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 name1 = config.get("name1").orElse("tf-testAccBackend");
        var default_ = new Backend("default", BackendArgs.builder()        
            .backendName(var_.name())
            .description(var_.name())
            .backendType("HTTP")
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name1 = config.get("name1")
if name1 is None:
    name1 = "tf-testAccBackend"
default = alicloud.apigateway.Backend("default",
    backend_name=var["name"],
    description=var["name"],
    backend_type="HTTP")

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

const config = new pulumi.Config();
const name1 = config.get("name1") || "tf-testAccBackend";
const _default = new alicloud.apigateway.Backend("default", {
    backendName: _var.name,
    description: _var.name,
    backendType: "HTTP",
});

configuration:
  name1:
    type: string
    default: tf-testAccBackend
resources:
  default:
    type: alicloud:apigateway:Backend
    properties:
      backendName: ${var.name}
      description: ${var.name}
      backendType: HTTP

Create Backend Resource

new Backend(name: string, args: BackendArgs, opts?: CustomResourceOptions);
@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)
@overload
def Backend(resource_name: str,
            args: BackendArgs,
            opts: Optional[ResourceOptions] = 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.
name string
The unique name of the resource.
args BackendArgs
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 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 string
The unique name of the resource.
args BackendArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BackendArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The Backend resource accepts the following input properties:

BackendName string

The name of the Backend.

BackendType string

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

CreateEventBridgeServiceLinkedRole 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 string

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

CreateEventBridgeServiceLinkedRole 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 String

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

createEventBridgeServiceLinkedRole 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 string

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

createEventBridgeServiceLinkedRole 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 str

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

create_event_bridge_service_linked_role 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 String

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

createEventBridgeServiceLinkedRole 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)
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:
BackendName string

The name of the Backend.

BackendType string

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

CreateEventBridgeServiceLinkedRole 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 string

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

CreateEventBridgeServiceLinkedRole 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 String

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

createEventBridgeServiceLinkedRole 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 string

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

createEventBridgeServiceLinkedRole 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 str

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

create_event_bridge_service_linked_role 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 String

The type of the Backend. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, MOCK.

createEventBridgeServiceLinkedRole 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>

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.