Docs Home
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
aws-native.apigateway.DocumentationVersion
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by 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 in the API Gateway Developer Guide.
Create DocumentationVersion Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DocumentationVersion(name: string, args: DocumentationVersionArgs, opts?: CustomResourceOptions);@overload
def DocumentationVersion(resource_name: str,
args: DocumentationVersionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DocumentationVersion(resource_name: str,
opts: Optional[ResourceOptions] = None,
documentation_version: Optional[str] = None,
rest_api_id: Optional[str] = None,
description: Optional[str] = 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.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DocumentationVersionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. DocumentationVersionArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DocumentationVersionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DocumentationVersion resource accepts the following input properties:
- Documentation
Version Value This property is required. string - The version identifier of the to-be-updated documentation version.
- Rest
Api Id This property is required. string - The string identifier of the associated RestApi.
- Description string
- A description about the new documentation snapshot.
- Documentation
Version This property is required. string - The version identifier of the to-be-updated documentation version.
- Rest
Api Id This property is required. string - The string identifier of the associated RestApi.
- Description string
- A description about the new documentation snapshot.
- documentation
Version This property is required. String - The version identifier of the to-be-updated documentation version.
- rest
Api Id This property is required. String - The string identifier of the associated RestApi.
- description String
- A description about the new documentation snapshot.
- documentation
Version This property is required. string - The version identifier of the to-be-updated documentation version.
- rest
Api Id This property is required. string - The string identifier of the associated RestApi.
- description string
- A description about the new documentation snapshot.
- documentation_
version This property is required. str - The version identifier of the to-be-updated documentation version.
- rest_
api_ id This property is required. str - The string identifier of the associated RestApi.
- description str
- A description about the new documentation snapshot.
- documentation
Version This property is required. String - The version identifier of the to-be-updated documentation version.
- rest
Api Id This property is required. String - The string identifier of the associated RestApi.
- description String
- A description about the new 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
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi