getExport

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ApigatewayFunctions;
import com.pulumi.aws.apigateway.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 example = ApigatewayFunctions.getExport(GetExportArgs.builder()
.restApiId(aws_api_gateway_stage.example().rest_api_id())
.stageName(aws_api_gateway_stage.example().stage_name())
.exportType("oas30")
.build());
}
}

Return

A collection of values returned by getExport.

Parameters

argument

A collection of arguments for invoking getExport.


suspend fun getExport(accepts: String? = null, exportType: String, parameters: Map<String, String>? = null, restApiId: String, stageName: String): GetExportResult

Return

A collection of values returned by getExport.

Parameters

accepts

Content-type of the export. Valid values are application/json and application/yaml are supported for export_type ofoas30 and swagger.

exportType

Type of export. Acceptable values are oas30 for OpenAPI 3.0.x and swagger for Swagger/OpenAPI 2.0.

parameters

Key-value map of query string parameters that specify properties of the export. the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions.

restApiId

Identifier of the associated REST API.

stageName

Name of the Stage that will be 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.apigateway.kotlin.inputs.GetExportPlainArgs.

See also