Package com.pulumi.aws.apigateway

Class MethodArgs

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MethodArgs.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 MethodArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> apiKeyRequired()  
      com.pulumi.core.Output<java.lang.String> authorization()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> authorizationScopes()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerId()  
      static MethodArgs.Builder builder()  
      static MethodArgs.Builder builder​(MethodArgs defaults)  
      com.pulumi.core.Output<java.lang.String> httpMethod()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> operationName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> requestModels()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Boolean>>> requestParameters()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> requestValidatorId()  
      com.pulumi.core.Output<java.lang.String> resourceId()  
      com.pulumi.core.Output<java.lang.String> restApi()  

      • 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

      • apiKeyRequired

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> apiKeyRequired()
        Returns:
        Specify if the method requires an API key

      • authorization

        public com.pulumi.core.Output<java.lang.String> authorization()
        Returns:
        Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)

      • authorizationScopes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> authorizationScopes()
        Returns:
        Authorization scopes used when the authorization is `COGNITO_USER_POOLS`

      • authorizerId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerId()
        Returns:
        Authorizer ID to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`

      • httpMethod

        public com.pulumi.core.Output<java.lang.String> httpMethod()
        Returns:
        HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)

      • operationName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> operationName()
        Returns:
        Function name that will be given to the method when generating an SDK through API Gateway. If omitted, API Gateway will generate a function name based on the resource path and HTTP verb.

      • 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.

      • requestModels

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> requestModels()
        Returns:
        Map of the API models used for the request's content type where key is the content type (e.g., `application/json`) and value is either `Error`, `Empty` (built-in models) or `aws.apigateway.Model`'s `name`.

      • requestParameters

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Boolean>>> requestParameters()
        Returns:
        Map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (`true`) or optional (`false`). For example: `requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true}` would define that the header `X-Some-Header` and the query string `some-query-param` must be provided in the request.

      • requestValidatorId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> requestValidatorId()
        Returns:
        ID of a `aws.apigateway.RequestValidator`

      • resourceId

        public com.pulumi.core.Output<java.lang.String> resourceId()
        Returns:
        API resource ID

      • restApi

        public com.pulumi.core.Output<java.lang.String> restApi()
        Returns:
        ID of the associated REST API