Package com.pulumi.aws.apigateway.inputs

Class DocumentationPartState

java.lang.Object

com.pulumi.resources.InputArgs

com.pulumi.resources.ResourceArgs

com.pulumi.aws.apigateway.inputs.DocumentationPartState

public final class DocumentationPartState
extends com.pulumi.resources.ResourceArgs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentationPartState.Builder

Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

com.pulumi.resources.InputArgs.InputArgsInternal

Field Summary

Fields

Modifier and Type	Field	Description
static DocumentationPartState	Empty

Method Summary

Modifier and Type	Method	Description
static DocumentationPartState.Builder	builder()
static DocumentationPartState.Builder	builder(DocumentationPartState defaults)
java.util.Optional<com.pulumi.core.Output<java.lang.String>>	documentationPartId()
java.util.Optional<com.pulumi.core.Output<DocumentationPartLocationArgs>>	location()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>	properties()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>	region()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>	restApiId()

Methods inherited from class com.pulumi.resources.ResourceArgs

validateMember

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Empty

public static final DocumentationPartState Empty

Method Detail

documentationPartId

public java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentationPartId()

Returns:

DocumentationPart identifier, generated by API Gateway when the documentation part is created.

location

public java.util.Optional<com.pulumi.core.Output<DocumentationPartLocationArgs>> location()

Returns:

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

properties

public java.util.Optional<com.pulumi.core.Output<java.lang.String>> properties()

Returns:

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.

region

public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()

Returns:

Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

restApiId

public java.util.Optional<com.pulumi.core.Output<java.lang.String>> restApiId()

Returns:

ID of the associated Rest API

builder

public static DocumentationPartState.Builder builder()

builder

public static DocumentationPartState.Builder builder(DocumentationPartState defaults)