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

tencentcloud.ApiGatewayApiDoc

Explore with Pulumi AI

tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

Provides a resource to create a APIGateway ApiDoc

Example Usage

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

const myApiDoc = new tencentcloud.ApiGatewayApiDoc("myApiDoc", {
    apiDocName: "doc_test1",
    apiIds: [
        "api-test1",
        "api-test2",
    ],
    environment: "release",
    serviceId: "service_test1",
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

my_api_doc = tencentcloud.ApiGatewayApiDoc("myApiDoc",
    api_doc_name="doc_test1",
    api_ids=[
        "api-test1",
        "api-test2",
    ],
    environment="release",
    service_id="service_test1")
Copy
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.NewApiGatewayApiDoc(ctx, "myApiDoc", &tencentcloud.ApiGatewayApiDocArgs{
			ApiDocName: pulumi.String("doc_test1"),
			ApiIds: pulumi.StringArray{
				pulumi.String("api-test1"),
				pulumi.String("api-test2"),
			},
			Environment: pulumi.String("release"),
			ServiceId:   pulumi.String("service_test1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var myApiDoc = new Tencentcloud.ApiGatewayApiDoc("myApiDoc", new()
    {
        ApiDocName = "doc_test1",
        ApiIds = new[]
        {
            "api-test1",
            "api-test2",
        },
        Environment = "release",
        ServiceId = "service_test1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayApiDoc;
import com.pulumi.tencentcloud.ApiGatewayApiDocArgs;
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 myApiDoc = new ApiGatewayApiDoc("myApiDoc", ApiGatewayApiDocArgs.builder()
            .apiDocName("doc_test1")
            .apiIds(            
                "api-test1",
                "api-test2")
            .environment("release")
            .serviceId("service_test1")
            .build());

    }
}
Copy
resources:
  myApiDoc:
    type: tencentcloud:ApiGatewayApiDoc
    properties:
      apiDocName: doc_test1
      apiIds:
        - api-test1
        - api-test2
      environment: release
      serviceId: service_test1
Copy

Create ApiGatewayApiDoc Resource

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

Constructor syntax

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

@overload
def ApiGatewayApiDoc(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     api_doc_name: Optional[str] = None,
                     api_ids: Optional[Sequence[str]] = None,
                     environment: Optional[str] = None,
                     service_id: Optional[str] = None,
                     api_gateway_api_doc_id: Optional[str] = None)
func NewApiGatewayApiDoc(ctx *Context, name string, args ApiGatewayApiDocArgs, opts ...ResourceOption) (*ApiGatewayApiDoc, error)
public ApiGatewayApiDoc(string name, ApiGatewayApiDocArgs args, CustomResourceOptions? opts = null)
public ApiGatewayApiDoc(String name, ApiGatewayApiDocArgs args)
public ApiGatewayApiDoc(String name, ApiGatewayApiDocArgs args, CustomResourceOptions options)

type: tencentcloud:ApiGatewayApiDoc
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. ApiGatewayApiDocArgs
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. ApiGatewayApiDocArgs
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. ApiGatewayApiDocArgs
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. ApiGatewayApiDocArgs
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. ApiGatewayApiDocArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ApiDocName This property is required. string
Api Document name.
ApiIds This property is required. List<string>
List of APIs for generating documents.
Environment This property is required. string
Env name.
ServiceId This property is required. string
Service name.
ApiGatewayApiDocId string
ID of the resource.
ApiDocName This property is required. string
Api Document name.
ApiIds This property is required. []string
List of APIs for generating documents.
Environment This property is required. string
Env name.
ServiceId This property is required. string
Service name.
ApiGatewayApiDocId string
ID of the resource.
apiDocName This property is required. String
Api Document name.
apiIds This property is required. List<String>
List of APIs for generating documents.
environment This property is required. String
Env name.
serviceId This property is required. String
Service name.
apiGatewayApiDocId String
ID of the resource.
apiDocName This property is required. string
Api Document name.
apiIds This property is required. string[]
List of APIs for generating documents.
environment This property is required. string
Env name.
serviceId This property is required. string
Service name.
apiGatewayApiDocId string
ID of the resource.
api_doc_name This property is required. str
Api Document name.
api_ids This property is required. Sequence[str]
List of APIs for generating documents.
environment This property is required. str
Env name.
service_id This property is required. str
Service name.
api_gateway_api_doc_id str
ID of the resource.
apiDocName This property is required. String
Api Document name.
apiIds This property is required. List<String>
List of APIs for generating documents.
environment This property is required. String
Env name.
serviceId This property is required. String
Service name.
apiGatewayApiDocId String
ID of the resource.

Outputs

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

ApiCount double
Api Document count.
ApiDocId string
Api Document ID.
ApiDocStatus string
API Document Build Status.
ApiDocUri string
API Document Access URI.
ApiNames List<string>
List of names for generating documents.
Id string
The provider-assigned unique ID for this managed resource.
ReleaseCount double
Number of API document releases.
ServiceName string
API Document service name.
SharePassword string
API Document Sharing Password.
UpdatedTime string
API Document update time.
ViewCount double
API Document Viewing Times.
ApiCount float64
Api Document count.
ApiDocId string
Api Document ID.
ApiDocStatus string
API Document Build Status.
ApiDocUri string
API Document Access URI.
ApiNames []string
List of names for generating documents.
Id string
The provider-assigned unique ID for this managed resource.
ReleaseCount float64
Number of API document releases.
ServiceName string
API Document service name.
SharePassword string
API Document Sharing Password.
UpdatedTime string
API Document update time.
ViewCount float64
API Document Viewing Times.
apiCount Double
Api Document count.
apiDocId String
Api Document ID.
apiDocStatus String
API Document Build Status.
apiDocUri String
API Document Access URI.
apiNames List<String>
List of names for generating documents.
id String
The provider-assigned unique ID for this managed resource.
releaseCount Double
Number of API document releases.
serviceName String
API Document service name.
sharePassword String
API Document Sharing Password.
updatedTime String
API Document update time.
viewCount Double
API Document Viewing Times.
apiCount number
Api Document count.
apiDocId string
Api Document ID.
apiDocStatus string
API Document Build Status.
apiDocUri string
API Document Access URI.
apiNames string[]
List of names for generating documents.
id string
The provider-assigned unique ID for this managed resource.
releaseCount number
Number of API document releases.
serviceName string
API Document service name.
sharePassword string
API Document Sharing Password.
updatedTime string
API Document update time.
viewCount number
API Document Viewing Times.
api_count float
Api Document count.
api_doc_id str
Api Document ID.
api_doc_status str
API Document Build Status.
api_doc_uri str
API Document Access URI.
api_names Sequence[str]
List of names for generating documents.
id str
The provider-assigned unique ID for this managed resource.
release_count float
Number of API document releases.
service_name str
API Document service name.
share_password str
API Document Sharing Password.
updated_time str
API Document update time.
view_count float
API Document Viewing Times.
apiCount Number
Api Document count.
apiDocId String
Api Document ID.
apiDocStatus String
API Document Build Status.
apiDocUri String
API Document Access URI.
apiNames List<String>
List of names for generating documents.
id String
The provider-assigned unique ID for this managed resource.
releaseCount Number
Number of API document releases.
serviceName String
API Document service name.
sharePassword String
API Document Sharing Password.
updatedTime String
API Document update time.
viewCount Number
API Document Viewing Times.

Look up Existing ApiGatewayApiDoc Resource

Get an existing ApiGatewayApiDoc 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?: ApiGatewayApiDocState, opts?: CustomResourceOptions): ApiGatewayApiDoc
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_count: Optional[float] = None,
        api_doc_id: Optional[str] = None,
        api_doc_name: Optional[str] = None,
        api_doc_status: Optional[str] = None,
        api_doc_uri: Optional[str] = None,
        api_gateway_api_doc_id: Optional[str] = None,
        api_ids: Optional[Sequence[str]] = None,
        api_names: Optional[Sequence[str]] = None,
        environment: Optional[str] = None,
        release_count: Optional[float] = None,
        service_id: Optional[str] = None,
        service_name: Optional[str] = None,
        share_password: Optional[str] = None,
        updated_time: Optional[str] = None,
        view_count: Optional[float] = None) -> ApiGatewayApiDoc
func GetApiGatewayApiDoc(ctx *Context, name string, id IDInput, state *ApiGatewayApiDocState, opts ...ResourceOption) (*ApiGatewayApiDoc, error)
public static ApiGatewayApiDoc Get(string name, Input<string> id, ApiGatewayApiDocState? state, CustomResourceOptions? opts = null)
public static ApiGatewayApiDoc get(String name, Output<String> id, ApiGatewayApiDocState state, CustomResourceOptions options)
resources:  _:    type: tencentcloud:ApiGatewayApiDoc    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:
ApiCount double
Api Document count.
ApiDocId string
Api Document ID.
ApiDocName string
Api Document name.
ApiDocStatus string
API Document Build Status.
ApiDocUri string
API Document Access URI.
ApiGatewayApiDocId string
ID of the resource.
ApiIds List<string>
List of APIs for generating documents.
ApiNames List<string>
List of names for generating documents.
Environment string
Env name.
ReleaseCount double
Number of API document releases.
ServiceId string
Service name.
ServiceName string
API Document service name.
SharePassword string
API Document Sharing Password.
UpdatedTime string
API Document update time.
ViewCount double
API Document Viewing Times.
ApiCount float64
Api Document count.
ApiDocId string
Api Document ID.
ApiDocName string
Api Document name.
ApiDocStatus string
API Document Build Status.
ApiDocUri string
API Document Access URI.
ApiGatewayApiDocId string
ID of the resource.
ApiIds []string
List of APIs for generating documents.
ApiNames []string
List of names for generating documents.
Environment string
Env name.
ReleaseCount float64
Number of API document releases.
ServiceId string
Service name.
ServiceName string
API Document service name.
SharePassword string
API Document Sharing Password.
UpdatedTime string
API Document update time.
ViewCount float64
API Document Viewing Times.
apiCount Double
Api Document count.
apiDocId String
Api Document ID.
apiDocName String
Api Document name.
apiDocStatus String
API Document Build Status.
apiDocUri String
API Document Access URI.
apiGatewayApiDocId String
ID of the resource.
apiIds List<String>
List of APIs for generating documents.
apiNames List<String>
List of names for generating documents.
environment String
Env name.
releaseCount Double
Number of API document releases.
serviceId String
Service name.
serviceName String
API Document service name.
sharePassword String
API Document Sharing Password.
updatedTime String
API Document update time.
viewCount Double
API Document Viewing Times.
apiCount number
Api Document count.
apiDocId string
Api Document ID.
apiDocName string
Api Document name.
apiDocStatus string
API Document Build Status.
apiDocUri string
API Document Access URI.
apiGatewayApiDocId string
ID of the resource.
apiIds string[]
List of APIs for generating documents.
apiNames string[]
List of names for generating documents.
environment string
Env name.
releaseCount number
Number of API document releases.
serviceId string
Service name.
serviceName string
API Document service name.
sharePassword string
API Document Sharing Password.
updatedTime string
API Document update time.
viewCount number
API Document Viewing Times.
api_count float
Api Document count.
api_doc_id str
Api Document ID.
api_doc_name str
Api Document name.
api_doc_status str
API Document Build Status.
api_doc_uri str
API Document Access URI.
api_gateway_api_doc_id str
ID of the resource.
api_ids Sequence[str]
List of APIs for generating documents.
api_names Sequence[str]
List of names for generating documents.
environment str
Env name.
release_count float
Number of API document releases.
service_id str
Service name.
service_name str
API Document service name.
share_password str
API Document Sharing Password.
updated_time str
API Document update time.
view_count float
API Document Viewing Times.
apiCount Number
Api Document count.
apiDocId String
Api Document ID.
apiDocName String
Api Document name.
apiDocStatus String
API Document Build Status.
apiDocUri String
API Document Access URI.
apiGatewayApiDocId String
ID of the resource.
apiIds List<String>
List of APIs for generating documents.
apiNames List<String>
List of names for generating documents.
environment String
Env name.
releaseCount Number
Number of API document releases.
serviceId String
Service name.
serviceName String
API Document service name.
sharePassword String
API Document Sharing Password.
updatedTime String
API Document update time.
viewCount Number
API Document Viewing Times.

Package Details

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