Class DocumentationPart

Provides a settings of an API Gateway Documentation Part.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var exampleRestApi = new Aws.ApiGateway.RestApi("exampleRestApi", new Aws.ApiGateway.RestApiArgs
    {
    });
    var exampleDocumentationPart = new Aws.ApiGateway.DocumentationPart("exampleDocumentationPart", new Aws.ApiGateway.DocumentationPartArgs
    {
        Location = new Aws.ApiGateway.Inputs.DocumentationPartLocationArgs
        {
            Method = "GET",
            Path = "/example",
            Type = "METHOD",
        },
        Properties = "{\"description\":\"Example description\"}",
        RestApiId = exampleRestApi.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

DocumentationPart

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGateway

Assembly: Pulumi.Aws.dll

Syntax

public class DocumentationPart : CustomResource

Constructors

DocumentationPart(String, DocumentationPartArgs, CustomResourceOptions)

Create a DocumentationPart resource with the given unique name, arguments, and options.

Declaration

public DocumentationPart(string name, DocumentationPartArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DocumentationPartArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Location

The location of the targeted API entity of the to-be-created documentation part. See below.

Declaration

public Output<DocumentationPartLocation> Location { get; }

Property Value

Type	Description
Output<DocumentationPartLocation>

Properties

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ "description": "The API does ..." }". Only Swagger-compliant key-value pairs can be exported and, hence, published.

Declaration

public Output<string> Properties { get; }

Property Value

Type	Description
Output<System.String>

RestApiId

The ID of the associated Rest API

Declaration

public Output<string> RestApiId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, DocumentationPartState, CustomResourceOptions)

Get an existing DocumentationPart resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static DocumentationPart Get(string name, Input<string> id, DocumentationPartState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DocumentationPartState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
DocumentationPart