1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. apigateway
  5. App
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.apigateway.App

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    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",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.apigateway.App("example",
        name="tf_example",
        description="tf_example")
    
    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
    	})
    }
    
    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",
        });
    
    });
    
    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());
    
        }
    }
    
    resources:
      example:
        type: alicloud:apigateway:App
        properties:
          name: tf_example
          description: tf_example
    

    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, Any]] = 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 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 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 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 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 String
    The unique name of the resource.
    args AppArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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", "any" },
        },
    });
    
    example, err := apigateway.NewApp(ctx, "appResource", &apigateway.AppArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Tags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var appResource = new App("appResource", AppArgs.builder()
        .description("string")
        .name("string")
        .tags(Map.of("string", "any"))
        .build());
    
    app_resource = alicloud.apigateway.App("appResource",
        description="string",
        name="string",
        tags={
            "string": "any",
        })
    
    const appResource = new alicloud.apigateway.App("appResource", {
        description: "string",
        name: "string",
        tags: {
            string: "any",
        },
    });
    
    type: alicloud:apigateway:App
    properties:
        description: string
        name: string
        tags:
            string: any
    

    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

    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, object>
    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]interface{}
    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,Object>
    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]: any}
    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, Any]
    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<Any>
    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, Any]] = 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)
    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:
    Description string
    The description of the app. Defaults to null.
    Name string
    The name of the app.
    Tags Dictionary<string, object>
    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]interface{}
    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,Object>
    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]: any}
    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, Any]
    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<Any>
    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"
    

    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.57.0 published on Saturday, Jun 15, 2024 by Pulumi