@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
187 lines (186 loc) • 5.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Allows management of [Yandex Cloud API Gateway](https://cloud.yandex.com/docs/api-gateway/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const test_api_gateway = new yandex.ApiGateway("test-api-gateway", {
* description: "any description",
* labels: {
* label: "label",
* "empty-label": "",
* },
* spec: `openapi: "3.0.0"
* info:
* version: 1.0.0
* title: Test API
* paths:
* /hello:
* get:
* summary: Say hello
* operationId: hello
* parameters:
* - name: user
* in: query
* description: User name to appear in greetings
* required: false
* schema:
* type: string
* default: 'world'
* responses:
* '200':
* description: Greeting
* content:
* 'text/plain':
* schema:
* type: "string"
* x-yc-apigateway-integration:
* type: dummy
* http_code: 200
* http_headers:
* 'Content-Type': "text/plain"
* content:
* 'text/plain': "Hello again, {user}!\n"
* `,
* });
* ```
*/
export declare class ApiGateway extends pulumi.CustomResource {
/**
* Get an existing ApiGateway resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiGatewayState, opts?: pulumi.CustomResourceOptions): ApiGateway;
/**
* Returns true if the given object is an instance of ApiGateway. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ApiGateway;
/**
* Creation timestamp of the Yandex Cloud API Gateway.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Description of the Yandex Cloud API Gateway.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Default domain for the Yandex API Gateway. Generated at creation time.
*/
readonly domain: pulumi.Output<string>;
/**
* Folder ID for the Yandex Cloud API Gateway. If it is not provided, the default provider folder is used.
*/
readonly folderId: pulumi.Output<string>;
/**
* A set of key/value label pairs to assign to the Yandex Cloud API Gateway.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly logGroupId: pulumi.Output<string>;
/**
* Yandex Cloud API Gateway name used to define API Gateway.
*/
readonly name: pulumi.Output<string>;
/**
* OpenAPI specification for Yandex API Gateway.
*/
readonly spec: pulumi.Output<string>;
/**
* Status of the Yandex API Gateway.
*/
readonly status: pulumi.Output<string>;
/**
* Set of user domains attached to Yandex API Gateway.
*/
readonly userDomains: pulumi.Output<string[]>;
/**
* Create a ApiGateway resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ApiGatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiGateway resources.
*/
export interface ApiGatewayState {
/**
* Creation timestamp of the Yandex Cloud API Gateway.
*/
createdAt?: pulumi.Input<string>;
/**
* Description of the Yandex Cloud API Gateway.
*/
description?: pulumi.Input<string>;
/**
* Default domain for the Yandex API Gateway. Generated at creation time.
*/
domain?: pulumi.Input<string>;
/**
* Folder ID for the Yandex Cloud API Gateway. If it is not provided, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* A set of key/value label pairs to assign to the Yandex Cloud API Gateway.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
logGroupId?: pulumi.Input<string>;
/**
* Yandex Cloud API Gateway name used to define API Gateway.
*/
name?: pulumi.Input<string>;
/**
* OpenAPI specification for Yandex API Gateway.
*/
spec?: pulumi.Input<string>;
/**
* Status of the Yandex API Gateway.
*/
status?: pulumi.Input<string>;
/**
* Set of user domains attached to Yandex API Gateway.
*/
userDomains?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a ApiGateway resource.
*/
export interface ApiGatewayArgs {
/**
* Description of the Yandex Cloud API Gateway.
*/
description?: pulumi.Input<string>;
/**
* Folder ID for the Yandex Cloud API Gateway. If it is not provided, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* A set of key/value label pairs to assign to the Yandex Cloud API Gateway.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Yandex Cloud API Gateway name used to define API Gateway.
*/
name?: pulumi.Input<string>;
/**
* OpenAPI specification for Yandex API Gateway.
*/
spec: pulumi.Input<string>;
}