Package com.pulumi.aws.apigateway

Class RestApiPutArgs

  • public final class RestApiPutArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RestApiPutArgs.Builder  

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

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> body()  
      static RestApiPutArgs.Builder builder()  
      static RestApiPutArgs.Builder builder​(RestApiPutArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> failOnWarnings()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> parameters()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      com.pulumi.core.Output<java.lang.String> restApiId()  
      java.util.Optional<com.pulumi.core.Output<RestApiPutTimeoutsArgs>> timeouts()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> triggers()  

      • 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

    • Method Detail

      • body

        public com.pulumi.core.Output<java.lang.String> body()
        Returns:
        PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

      • failOnWarnings

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> failOnWarnings()
        Returns:
        Whether to rollback the API update when a warning is encountered. The default value is `false`.

      • parameters

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> parameters()
        Returns:
        Map of customizations for importing the specification in the `body` argument. For example, to exclude DocumentationParts from an imported API, use `ignore = "documentation"`. Additional documentation, including other parameters such as `basepath`, can be found in the [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).

      • 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 com.pulumi.core.Output<java.lang.String> restApiId()
        Returns:
        Identifier of the associated REST API. The following arguments are optional:

      • triggers

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> triggers()
        Returns:
        Map of arbitrary keys and values that, when changed, will trigger a redeployment. To force a redeployment without changing these keys/values, use the `-replace` option with `pulumi preview` or `pulumi up`.