@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
123 lines (122 loc) • 4.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.apigateway.getExport({
* restApiId: exampleAwsApiGatewayStage.restApiId,
* stageName: exampleAwsApiGatewayStage.stageName,
* exportType: "oas30",
* });
* ```
*/
export declare function getExport(args: GetExportArgs, opts?: pulumi.InvokeOptions): Promise<GetExportResult>;
/**
* A collection of arguments for invoking getExport.
*/
export interface GetExportArgs {
/**
* Content-type of the export. Valid values are `application/json` and `application/yaml` are supported for `exportType` `ofoas30` and `swagger`.
*/
accepts?: string;
/**
* Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0.
*/
exportType: string;
/**
* 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.
*/
parameters?: {
[key: string]: string;
};
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* Identifier of the associated REST API.
*/
restApiId: string;
/**
* Name of the Stage that will be exported.
*/
stageName: string;
}
/**
* A collection of values returned by getExport.
*/
export interface GetExportResult {
readonly accepts?: string;
/**
* API Spec.
*/
readonly body: string;
/**
* Content-disposition header value in the HTTP response.
*/
readonly contentDisposition: string;
/**
* Content-type header value in the HTTP response.
*/
readonly contentType: string;
readonly exportType: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly parameters?: {
[key: string]: string;
};
readonly region: string;
readonly restApiId: string;
readonly stageName: string;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.apigateway.getExport({
* restApiId: exampleAwsApiGatewayStage.restApiId,
* stageName: exampleAwsApiGatewayStage.stageName,
* exportType: "oas30",
* });
* ```
*/
export declare function getExportOutput(args: GetExportOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetExportResult>;
/**
* A collection of arguments for invoking getExport.
*/
export interface GetExportOutputArgs {
/**
* Content-type of the export. Valid values are `application/json` and `application/yaml` are supported for `exportType` `ofoas30` and `swagger`.
*/
accepts?: pulumi.Input<string>;
/**
* Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0.
*/
exportType: pulumi.Input<string>;
/**
* 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.
*/
parameters?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Identifier of the associated REST API.
*/
restApiId: pulumi.Input<string>;
/**
* Name of the Stage that will be exported.
*/
stageName: pulumi.Input<string>;
}