@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
58 lines (57 loc) • 2.58 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
*/
export declare class DocumentationVersion extends pulumi.CustomResource {
/**
* Get an existing DocumentationVersion 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): DocumentationVersion;
/**
* Returns true if the given object is an instance of DocumentationVersion. 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 DocumentationVersion;
/**
* A description about the new documentation snapshot.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The version identifier of the to-be-updated documentation version.
*/
readonly documentationVersion: pulumi.Output<string>;
/**
* The string identifier of the associated RestApi.
*/
readonly restApiId: pulumi.Output<string>;
/**
* Create a DocumentationVersion 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: DocumentationVersionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a DocumentationVersion resource.
*/
export interface DocumentationVersionArgs {
/**
* A description about the new documentation snapshot.
*/
description?: pulumi.Input<string>;
/**
* The version identifier of the to-be-updated documentation version.
*/
documentationVersion: pulumi.Input<string>;
/**
* The string identifier of the associated RestApi.
*/
restApiId: pulumi.Input<string>;
}