Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ApiGatewayApiApp
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.ApiGatewayApiApp

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create a APIGateway ApiApp

    Example Usage

    Create a basic apigateway api_app

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

const example = new tencentcloud.ApiGatewayApiApp("example", {
    apiAppDesc: "app desc.",
    apiAppName: "tf_example",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ApiGatewayApiApp("example",
    api_app_desc="app desc.",
    api_app_name="tf_example")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewApiGatewayApiApp(ctx, "example", &tencentcloud.ApiGatewayApiAppArgs{
			ApiAppDesc: pulumi.String("app desc."),
			ApiAppName: pulumi.String("tf_example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.ApiGatewayApiApp("example", new()
    {
        ApiAppDesc = "app desc.",
        ApiAppName = "tf_example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayApiApp;
import com.pulumi.tencentcloud.ApiGatewayApiAppArgs;
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 ApiGatewayApiApp("example", ApiGatewayApiAppArgs.builder()
            .apiAppDesc("app desc.")
            .apiAppName("tf_example")
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ApiGatewayApiApp
    properties:
      apiAppDesc: app desc.
      apiAppName: tf_example

    Bind Tag

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

const example = new tencentcloud.ApiGatewayApiApp("example", {
    apiAppDesc: "app desc.",
    apiAppName: "tf_example",
    tags: {
        createdBy: "terraform",
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ApiGatewayApiApp("example",
    api_app_desc="app desc.",
    api_app_name="tf_example",
    tags={
        "createdBy": "terraform",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewApiGatewayApiApp(ctx, "example", &tencentcloud.ApiGatewayApiAppArgs{
			ApiAppDesc: pulumi.String("app desc."),
			ApiAppName: pulumi.String("tf_example"),
			Tags: pulumi.StringMap{
				"createdBy": pulumi.String("terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.ApiGatewayApiApp("example", new()
    {
        ApiAppDesc = "app desc.",
        ApiAppName = "tf_example",
        Tags = 
        {
            { "createdBy", "terraform" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayApiApp;
import com.pulumi.tencentcloud.ApiGatewayApiAppArgs;
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 ApiGatewayApiApp("example", ApiGatewayApiAppArgs.builder()
            .apiAppDesc("app desc.")
            .apiAppName("tf_example")
            .tags(Map.of("createdBy", "terraform"))
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ApiGatewayApiApp
    properties:
      apiAppDesc: app desc.
      apiAppName: tf_example
      tags:
        createdBy: terraform

    Create ApiGatewayApiApp Resource

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

    Constructor syntax

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

@overload
def ApiGatewayApiApp(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     api_app_name: Optional[str] = None,
                     api_app_desc: Optional[str] = None,
                     api_gateway_api_app_id: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewApiGatewayApiApp(ctx *Context, name string, args ApiGatewayApiAppArgs, opts ...ResourceOption) (*ApiGatewayApiApp, error)
    public ApiGatewayApiApp(string name, ApiGatewayApiAppArgs args, CustomResourceOptions? opts = null)
    public ApiGatewayApiApp(String name, ApiGatewayApiAppArgs args)
public ApiGatewayApiApp(String name, ApiGatewayApiAppArgs args, CustomResourceOptions options)

    type: tencentcloud:ApiGatewayApiApp
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 ApiGatewayApiAppArgs
    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 ApiGatewayApiAppArgs
    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 ApiGatewayApiAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiGatewayApiAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiGatewayApiAppArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ApiAppName string
    Api app name.
    ApiAppDesc string
    App description.
    ApiGatewayApiAppId string
    ID of the resource.
    Tags Dictionary<string, string>
    Tag description list.
    ApiAppName string
    Api app name.
    ApiAppDesc string
    App description.
    ApiGatewayApiAppId string
    ID of the resource.
    Tags map[string]string
    Tag description list.
    apiAppName String
    Api app name.
    apiAppDesc String
    App description.
    apiGatewayApiAppId String
    ID of the resource.
    tags Map<String,String>
    Tag description list.
    apiAppName string
    Api app name.
    apiAppDesc string
    App description.
    apiGatewayApiAppId string
    ID of the resource.
    tags {[key: string]: string}
    Tag description list.
    api_app_name str
    Api app name.
    api_app_desc str
    App description.
    api_gateway_api_app_id str
    ID of the resource.
    tags Mapping[str, str]
    Tag description list.
    apiAppName String
    Api app name.
    apiAppDesc String
    App description.
    apiGatewayApiAppId String
    ID of the resource.
    tags Map<String>
    Tag description list.

    Outputs

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

    ApiAppId string
    Api app ID.
    ApiAppKey string
    Api app key.
    ApiAppSecret string
    Api app secret.
    CreatedTime string
    Api app created time.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedTime string
    Api app modified time.
    ApiAppId string
    Api app ID.
    ApiAppKey string
    Api app key.
    ApiAppSecret string
    Api app secret.
    CreatedTime string
    Api app created time.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedTime string
    Api app modified time.
    apiAppId String
    Api app ID.
    apiAppKey String
    Api app key.
    apiAppSecret String
    Api app secret.
    createdTime String
    Api app created time.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedTime String
    Api app modified time.
    apiAppId string
    Api app ID.
    apiAppKey string
    Api app key.
    apiAppSecret string
    Api app secret.
    createdTime string
    Api app created time.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedTime string
    Api app modified time.
    api_app_id str
    Api app ID.
    api_app_key str
    Api app key.
    api_app_secret str
    Api app secret.
    created_time str
    Api app created time.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_time str
    Api app modified time.
    apiAppId String
    Api app ID.
    apiAppKey String
    Api app key.
    apiAppSecret String
    Api app secret.
    createdTime String
    Api app created time.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedTime String
    Api app modified time.

    Look up Existing ApiGatewayApiApp Resource

    Get an existing ApiGatewayApiApp 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?: ApiGatewayApiAppState, opts?: CustomResourceOptions): ApiGatewayApiApp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_app_desc: Optional[str] = None,
        api_app_id: Optional[str] = None,
        api_app_key: Optional[str] = None,
        api_app_name: Optional[str] = None,
        api_app_secret: Optional[str] = None,
        api_gateway_api_app_id: Optional[str] = None,
        created_time: Optional[str] = None,
        modified_time: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> ApiGatewayApiApp
    func GetApiGatewayApiApp(ctx *Context, name string, id IDInput, state *ApiGatewayApiAppState, opts ...ResourceOption) (*ApiGatewayApiApp, error)
    public static ApiGatewayApiApp Get(string name, Input<string> id, ApiGatewayApiAppState? state, CustomResourceOptions? opts = null)
    public static ApiGatewayApiApp get(String name, Output<String> id, ApiGatewayApiAppState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ApiGatewayApiApp    get:      id: ${id}
    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:
    ApiAppDesc string
    App description.
    ApiAppId string
    Api app ID.
    ApiAppKey string
    Api app key.
    ApiAppName string
    Api app name.
    ApiAppSecret string
    Api app secret.
    ApiGatewayApiAppId string
    ID of the resource.
    CreatedTime string
    Api app created time.
    ModifiedTime string
    Api app modified time.
    Tags Dictionary<string, string>
    Tag description list.
    ApiAppDesc string
    App description.
    ApiAppId string
    Api app ID.
    ApiAppKey string
    Api app key.
    ApiAppName string
    Api app name.
    ApiAppSecret string
    Api app secret.
    ApiGatewayApiAppId string
    ID of the resource.
    CreatedTime string
    Api app created time.
    ModifiedTime string
    Api app modified time.
    Tags map[string]string
    Tag description list.
    apiAppDesc String
    App description.
    apiAppId String
    Api app ID.
    apiAppKey String
    Api app key.
    apiAppName String
    Api app name.
    apiAppSecret String
    Api app secret.
    apiGatewayApiAppId String
    ID of the resource.
    createdTime String
    Api app created time.
    modifiedTime String
    Api app modified time.
    tags Map<String,String>
    Tag description list.
    apiAppDesc string
    App description.
    apiAppId string
    Api app ID.
    apiAppKey string
    Api app key.
    apiAppName string
    Api app name.
    apiAppSecret string
    Api app secret.
    apiGatewayApiAppId string
    ID of the resource.
    createdTime string
    Api app created time.
    modifiedTime string
    Api app modified time.
    tags {[key: string]: string}
    Tag description list.
    api_app_desc str
    App description.
    api_app_id str
    Api app ID.
    api_app_key str
    Api app key.
    api_app_name str
    Api app name.
    api_app_secret str
    Api app secret.
    api_gateway_api_app_id str
    ID of the resource.
    created_time str
    Api app created time.
    modified_time str
    Api app modified time.
    tags Mapping[str, str]
    Tag description list.
    apiAppDesc String
    App description.
    apiAppId String
    Api app ID.
    apiAppKey String
    Api app key.
    apiAppName String
    Api app name.
    apiAppSecret String
    Api app secret.
    apiGatewayApiAppId String
    ID of the resource.
    createdTime String
    Api app created time.
    modifiedTime String
    Api app modified time.
    tags Map<String>
    Tag description list.

    Import

    apigateway api_app can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/apiGatewayApiApp:ApiGatewayApiApp example app-poe0pyex

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud