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

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

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

aws-native.apigateway.DocumentationPart

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

    Resource Type definition for AWS::ApiGateway::DocumentationPart

    Create DocumentationPart Resource

    new DocumentationPart(name: string, args: DocumentationPartArgs, opts?: CustomResourceOptions);
    @overload
    def DocumentationPart(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          location: Optional[DocumentationPartLocationArgs] = None,
                          properties: Optional[str] = None,
                          rest_api_id: Optional[str] = None)
    @overload
    def DocumentationPart(resource_name: str,
                          args: DocumentationPartArgs,
                          opts: Optional[ResourceOptions] = None)
    func NewDocumentationPart(ctx *Context, name string, args DocumentationPartArgs, opts ...ResourceOption) (*DocumentationPart, error)
    public DocumentationPart(string name, DocumentationPartArgs args, CustomResourceOptions? opts = null)
    public DocumentationPart(String name, DocumentationPartArgs args)
    public DocumentationPart(String name, DocumentationPartArgs args, CustomResourceOptions options)
    
    type: aws-native:apigateway:DocumentationPart
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DocumentationPartArgs
    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 DocumentationPartArgs
    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 DocumentationPartArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentationPartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentationPartArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DocumentationPart 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 DocumentationPart resource accepts the following input properties:

    Location Pulumi.AwsNative.ApiGateway.Inputs.DocumentationPartLocation

    The location of the API entity that the documentation applies to.

    Properties string

    The documentation content map of the targeted API entity.

    RestApiId string

    Identifier of the targeted API entity

    Location DocumentationPartLocationArgs

    The location of the API entity that the documentation applies to.

    Properties string

    The documentation content map of the targeted API entity.

    RestApiId string

    Identifier of the targeted API entity

    location DocumentationPartLocation

    The location of the API entity that the documentation applies to.

    properties String

    The documentation content map of the targeted API entity.

    restApiId String

    Identifier of the targeted API entity

    location DocumentationPartLocation

    The location of the API entity that the documentation applies to.

    properties string

    The documentation content map of the targeted API entity.

    restApiId string

    Identifier of the targeted API entity

    location DocumentationPartLocationArgs

    The location of the API entity that the documentation applies to.

    properties str

    The documentation content map of the targeted API entity.

    rest_api_id str

    Identifier of the targeted API entity

    location Property Map

    The location of the API entity that the documentation applies to.

    properties String

    The documentation content map of the targeted API entity.

    restApiId String

    Identifier of the targeted API entity

    Outputs

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

    DocumentationPartId string

    The identifier of the documentation Part.

    Id string

    The provider-assigned unique ID for this managed resource.

    DocumentationPartId string

    The identifier of the documentation Part.

    Id string

    The provider-assigned unique ID for this managed resource.

    documentationPartId String

    The identifier of the documentation Part.

    id String

    The provider-assigned unique ID for this managed resource.

    documentationPartId string

    The identifier of the documentation Part.

    id string

    The provider-assigned unique ID for this managed resource.

    documentation_part_id str

    The identifier of the documentation Part.

    id str

    The provider-assigned unique ID for this managed resource.

    documentationPartId String

    The identifier of the documentation Part.

    id String

    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DocumentationPartLocation, DocumentationPartLocationArgs

    Method string

    The HTTP verb of a method.

    Name string

    The name of the targeted API entity.

    Path string

    The URL path of the target.

    StatusCode string

    The HTTP status code of a response.

    Type Pulumi.AwsNative.ApiGateway.DocumentationPartLocationType

    The type of API entity that the documentation content applies to.

    Method string

    The HTTP verb of a method.

    Name string

    The name of the targeted API entity.

    Path string

    The URL path of the target.

    StatusCode string

    The HTTP status code of a response.

    Type DocumentationPartLocationType

    The type of API entity that the documentation content applies to.

    method String

    The HTTP verb of a method.

    name String

    The name of the targeted API entity.

    path String

    The URL path of the target.

    statusCode String

    The HTTP status code of a response.

    type DocumentationPartLocationType

    The type of API entity that the documentation content applies to.

    method string

    The HTTP verb of a method.

    name string

    The name of the targeted API entity.

    path string

    The URL path of the target.

    statusCode string

    The HTTP status code of a response.

    type DocumentationPartLocationType

    The type of API entity that the documentation content applies to.

    method str

    The HTTP verb of a method.

    name str

    The name of the targeted API entity.

    path str

    The URL path of the target.

    status_code str

    The HTTP status code of a response.

    type DocumentationPartLocationType

    The type of API entity that the documentation content applies to.

    method String

    The HTTP verb of a method.

    name String

    The name of the targeted API entity.

    path String

    The URL path of the target.

    statusCode String

    The HTTP status code of a response.

    type "API" | "AUTHORIZER" | "MODEL" | "RESOURCE" | "METHOD" | "PATH_PARAMETER" | "QUERY_PARAMETER" | "REQUEST_HEADER" | "REQUEST_BODY" | "RESPONSE" | "RESPONSE_HEADER" | "RESPONSE_BODY"

    The type of API entity that the documentation content applies to.

    DocumentationPartLocationType, DocumentationPartLocationTypeArgs

    Api
    API
    Authorizer
    AUTHORIZER
    Model
    MODEL
    Resource
    RESOURCE
    Method
    METHOD
    PathParameter
    PATH_PARAMETER
    QueryParameter
    QUERY_PARAMETER
    RequestHeader
    REQUEST_HEADER
    RequestBody
    REQUEST_BODY
    Response
    RESPONSE
    ResponseHeader
    RESPONSE_HEADER
    ResponseBody
    RESPONSE_BODY
    DocumentationPartLocationTypeApi
    API
    DocumentationPartLocationTypeAuthorizer
    AUTHORIZER
    DocumentationPartLocationTypeModel
    MODEL
    DocumentationPartLocationTypeResource
    RESOURCE
    DocumentationPartLocationTypeMethod
    METHOD
    DocumentationPartLocationTypePathParameter
    PATH_PARAMETER
    DocumentationPartLocationTypeQueryParameter
    QUERY_PARAMETER
    DocumentationPartLocationTypeRequestHeader
    REQUEST_HEADER
    DocumentationPartLocationTypeRequestBody
    REQUEST_BODY
    DocumentationPartLocationTypeResponse
    RESPONSE
    DocumentationPartLocationTypeResponseHeader
    RESPONSE_HEADER
    DocumentationPartLocationTypeResponseBody
    RESPONSE_BODY
    Api
    API
    Authorizer
    AUTHORIZER
    Model
    MODEL
    Resource
    RESOURCE
    Method
    METHOD
    PathParameter
    PATH_PARAMETER
    QueryParameter
    QUERY_PARAMETER
    RequestHeader
    REQUEST_HEADER
    RequestBody
    REQUEST_BODY
    Response
    RESPONSE
    ResponseHeader
    RESPONSE_HEADER
    ResponseBody
    RESPONSE_BODY
    Api
    API
    Authorizer
    AUTHORIZER
    Model
    MODEL
    Resource
    RESOURCE
    Method
    METHOD
    PathParameter
    PATH_PARAMETER
    QueryParameter
    QUERY_PARAMETER
    RequestHeader
    REQUEST_HEADER
    RequestBody
    REQUEST_BODY
    Response
    RESPONSE
    ResponseHeader
    RESPONSE_HEADER
    ResponseBody
    RESPONSE_BODY
    API
    API
    AUTHORIZER
    AUTHORIZER
    MODEL
    MODEL
    RESOURCE
    RESOURCE
    METHOD
    METHOD
    PATH_PARAMETER
    PATH_PARAMETER
    QUERY_PARAMETER
    QUERY_PARAMETER
    REQUEST_HEADER
    REQUEST_HEADER
    REQUEST_BODY
    REQUEST_BODY
    RESPONSE
    RESPONSE
    RESPONSE_HEADER
    RESPONSE_HEADER
    RESPONSE_BODY
    RESPONSE_BODY
    "API"
    API
    "AUTHORIZER"
    AUTHORIZER
    "MODEL"
    MODEL
    "RESOURCE"
    RESOURCE
    "METHOD"
    METHOD
    "PATH_PARAMETER"
    PATH_PARAMETER
    "QUERY_PARAMETER"
    QUERY_PARAMETER
    "REQUEST_HEADER"
    REQUEST_HEADER
    "REQUEST_BODY"
    REQUEST_BODY
    "RESPONSE"
    RESPONSE
    "RESPONSE_HEADER"
    RESPONSE_HEADER
    "RESPONSE_BODY"
    RESPONSE_BODY

    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.77.0 published on Wednesday, Sep 20, 2023 by Pulumi