AWS Native is in preview. AWS Classic is fully supported.
aws-native.apigateway.DocumentationPart
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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.
Aws Native. Api Gateway. Inputs. Documentation Part Location The location of the API entity that the documentation applies to.
- Properties string
The documentation content map of the targeted API entity.
- Rest
Api stringId Identifier of the targeted API entity
- Location
Documentation
Part Location Args The location of the API entity that the documentation applies to.
- Properties string
The documentation content map of the targeted API entity.
- Rest
Api stringId Identifier of the targeted API entity
- location
Documentation
Part Location The location of the API entity that the documentation applies to.
- properties String
The documentation content map of the targeted API entity.
- rest
Api StringId Identifier of the targeted API entity
- location
Documentation
Part Location The location of the API entity that the documentation applies to.
- properties string
The documentation content map of the targeted API entity.
- rest
Api stringId Identifier of the targeted API entity
- location
Documentation
Part Location Args The location of the API entity that the documentation applies to.
- properties str
The documentation content map of the targeted API entity.
- rest_
api_ strid 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.
- rest
Api StringId 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:
- Documentation
Part stringId The identifier of the documentation Part.
- Id string
The provider-assigned unique ID for this managed resource.
- Documentation
Part stringId The identifier of the documentation Part.
- Id string
The provider-assigned unique ID for this managed resource.
- documentation
Part StringId The identifier of the documentation Part.
- id String
The provider-assigned unique ID for this managed resource.
- documentation
Part stringId The identifier of the documentation Part.
- id string
The provider-assigned unique ID for this managed resource.
- documentation_
part_ strid The identifier of the documentation Part.
- id str
The provider-assigned unique ID for this managed resource.
- documentation
Part StringId 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.
- Status
Code string The HTTP status code of a response.
- Type
Pulumi.
Aws Native. Api Gateway. Documentation Part Location Type 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.
- Status
Code string The HTTP status code of a response.
- Type
Documentation
Part Location Type 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.
- status
Code String The HTTP status code of a response.
- type
Documentation
Part Location Type 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.
- status
Code string The HTTP status code of a response.
- type
Documentation
Part Location Type 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
Documentation
Part Location Type 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.
- status
Code 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
- 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
- Documentation
Part Location Type Api - API
- Documentation
Part Location Type Authorizer - AUTHORIZER
- Documentation
Part Location Type Model - MODEL
- Documentation
Part Location Type Resource - RESOURCE
- Documentation
Part Location Type Method - METHOD
- Documentation
Part Location Type Path Parameter - PATH_PARAMETER
- Documentation
Part Location Type Query Parameter - QUERY_PARAMETER
- Documentation
Part Location Type Request Header - REQUEST_HEADER
- Documentation
Part Location Type Request Body - REQUEST_BODY
- Documentation
Part Location Type Response - RESPONSE
- Documentation
Part Location Type Response Header - RESPONSE_HEADER
- Documentation
Part Location Type 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
- 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
- "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 is in preview. AWS Classic is fully supported.