1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. DocumentationVersion

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.apigateway.DocumentationVersion

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 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 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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const documentationVersionResource = new aws_native.apigateway.DocumentationVersion("documentationVersionResource", {
        documentationVersion: "string",
        restApiId: "string",
        description: "string",
    });
    
    Coming soon!
    

    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 to-be-updated documentation version.
    RestApiId string
    The string identifier of the associated RestApi.
    Description string
    A description about the new documentation snapshot.
    DocumentationVersion string
    The version identifier of the to-be-updated documentation version.
    RestApiId string
    The string identifier of the associated RestApi.
    Description string
    A description about the new documentation snapshot.
    documentationVersion String
    The version identifier of the to-be-updated documentation version.
    restApiId String
    The string identifier of the associated RestApi.
    description String
    A description about the new documentation snapshot.
    documentationVersion string
    The version identifier of the to-be-updated documentation version.
    restApiId string
    The string identifier of the associated RestApi.
    description string
    A description about the new documentation snapshot.
    documentation_version str
    The version identifier of the to-be-updated documentation version.
    rest_api_id str
    The string identifier of the associated RestApi.
    description str
    A description about the new documentation snapshot.
    documentationVersion String
    The version identifier of the to-be-updated documentation version.
    restApiId 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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi