pulumi-aws-kotlin/com.pulumi.aws.apigatewayv2.kotlin/Apigatewayv2Functions/getExport

getExport

suspend fun getExport(argument: GetExportPlainArgs): GetExportResult

Exports a definition of an API in a particular output format and specification.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Apigatewayv2Functions;
import com.pulumi.aws.apigatewayv2.inputs.GetExportArgs;
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) {
        final var test = Apigatewayv2Functions.getExport(GetExportArgs.builder()
            .apiId(aws_apigatewayv2_route.test().api_id())
            .specification("OAS30")
            .outputType("JSON")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getExport.

Parameters

argument

A collection of arguments for invoking getExport.

suspend fun getExport(apiId: String, exportVersion: String? = null, includeExtensions: Boolean? = null, outputType: String, specification: String, stageName: String? = null): GetExportResult

Return

A collection of values returned by getExport.

Parameters

apiId

API identifier.

exportVersion

Version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

includeExtensions

Whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

outputType

Output type of the exported definition file. Valid values are JSON and YAML.

specification

Version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

stageName

Name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

See also

.

suspend fun getExport(argument: suspend GetExportPlainArgsBuilder.() -> Unit): GetExportResult

Return

A collection of values returned by getExport.

Parameters

argument

Builder for com.pulumi.aws.apigatewayv2.kotlin.inputs.GetExportPlainArgs.

See also

.