AWS Native v0.63.0, May 25 23

aws-native.apigateway.DocumentationVersion

Explore with Pulumi AI

A snapshot of the documentation of an API.

Create DocumentationVersion Resource

new DocumentationVersion(name: string, args: DocumentationVersionArgs, opts?: CustomResourceOptions);

@overload
def DocumentationVersion(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         description: Optional[str] = None,
                         documentation_version: Optional[str] = None,
                         rest_api_id: Optional[str] = None)
@overload
def DocumentationVersion(resource_name: str,
                         args: DocumentationVersionArgs,
                         opts: Optional[ResourceOptions] = None)

func NewDocumentationVersion(ctx *Context, name string, args DocumentationVersionArgs, opts ...ResourceOption) (*DocumentationVersion, error)

public DocumentationVersion(string name, DocumentationVersionArgs args, CustomResourceOptions? opts = null)

public DocumentationVersion(String name, DocumentationVersionArgs args)
public DocumentationVersion(String name, DocumentationVersionArgs args, CustomResourceOptions options)

type: aws-native:apigateway:DocumentationVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DocumentationVersionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DocumentationVersionArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DocumentationVersionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DocumentationVersionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DocumentationVersionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

DocumentationVersion Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DocumentationVersion resource accepts the following input properties:

DocumentationVersionValue string: The version identifier of the API documentation snapshot.
RestApiId string: The identifier of the API.
Description string: The description of the API documentation snapshot.

DocumentationVersion string: The version identifier of the API documentation snapshot.
RestApiId string: The identifier of the API.
Description string: The description of the API documentation snapshot.

documentationVersion String: The version identifier of the API documentation snapshot.
restApiId String: The identifier of the API.
description String: The description of the API documentation snapshot.

documentationVersion string: The version identifier of the API documentation snapshot.
restApiId string: The identifier of the API.
description string: The description of the API documentation snapshot.

documentation_version str: The version identifier of the API documentation snapshot.
rest_api_id str: The identifier of the API.
description str: The description of the API documentation snapshot.

documentationVersion String: The version identifier of the API documentation snapshot.
restApiId String: The identifier of the API.
description String: The description of the API documentation snapshot.

Outputs

All input properties are implicitly available as output properties. Additionally, the DocumentationVersion resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0