1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. apigateway
  5. App
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.apigateway.App

Explore with Pulumi AI

Example Usage

Basic Usage

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

const example = new alicloud.apigateway.App("example", {
    name: "tf_example",
    description: "tf_example",
});
Copy
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.apigateway.App("example",
    name="tf_example",
    description="tf_example")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApp(ctx, "example", &apigateway.AppArgs{
			Name:        pulumi.String("tf_example"),
			Description: pulumi.String("tf_example"),
		})
		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 example = new AliCloud.ApiGateway.App("example", new()
    {
        Name = "tf_example",
        Description = "tf_example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.App;
import com.pulumi.alicloud.apigateway.AppArgs;
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) {
        var example = new App("example", AppArgs.builder()
            .name("tf_example")
            .description("tf_example")
            .build());

    }
}
Copy
resources:
  example:
    type: alicloud:apigateway:App
    properties:
      name: tf_example
      description: tf_example
Copy

Create App Resource

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

Constructor syntax

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

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None)
func NewApp(ctx *Context, name string, args *AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs? args = null, CustomResourceOptions? opts = null)
public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)
type: alicloud:apigateway:App
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 AppArgs
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 AppArgs
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 AppArgs
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 AppArgs
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. AppArgs
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 appResource = new AliCloud.ApiGateway.App("appResource", new()
{
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := apigateway.NewApp(ctx, "appResource", &apigateway.AppArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var appResource = new App("appResource", AppArgs.builder()
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
app_resource = alicloud.apigateway.App("appResource",
    description="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const appResource = new alicloud.apigateway.App("appResource", {
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: alicloud:apigateway:App
properties:
    description: string
    name: string
    tags:
        string: string
Copy

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

Description string
The description of the app. Defaults to null.
Name string
The name of the app.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Description string
The description of the app. Defaults to null.
Name string
The name of the app.
Tags map[string]string
A mapping of tags to assign to the resource.
description String
The description of the app. Defaults to null.
name String
The name of the app.
tags Map<String,String>
A mapping of tags to assign to the resource.
description string
The description of the app. Defaults to null.
name string
The name of the app.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
description str
The description of the app. Defaults to null.
name str
The name of the app.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
description String
The description of the app. Defaults to null.
name String
The name of the app.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

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

Get an existing App 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?: AppState, opts?: CustomResourceOptions): App
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> App
func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)
resources:  _:    type: alicloud:apigateway:App    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:
Description string
The description of the app. Defaults to null.
Name string
The name of the app.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Description string
The description of the app. Defaults to null.
Name string
The name of the app.
Tags map[string]string
A mapping of tags to assign to the resource.
description String
The description of the app. Defaults to null.
name String
The name of the app.
tags Map<String,String>
A mapping of tags to assign to the resource.
description string
The description of the app. Defaults to null.
name string
The name of the app.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
description str
The description of the app. Defaults to null.
name str
The name of the app.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
description String
The description of the app. Defaults to null.
name String
The name of the app.
tags Map<String>
A mapping of tags to assign to the resource.

Import

Api gateway app can be imported using the id, e.g.

$ pulumi import alicloud:apigateway/app:App example "7379660"
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.