Package com.pulumi.aws.apigateway

Class RestApiArgs

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RestApiArgs.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 RestApiArgs 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.String>> apiKeySource()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> binaryMediaTypes()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> body()  
      static RestApiArgs.Builder builder()  
      static RestApiArgs.Builder builder​(RestApiArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> disableExecuteApiEndpoint()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpointAccessMode()  
      java.util.Optional<com.pulumi.core.Output<RestApiEndpointConfigurationArgs>> endpointConfiguration()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> failOnWarnings()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> minimumCompressionSize()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      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>> policy()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> putRestApiMode()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> securityPolicy()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  

      • 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

      • apiKeySource

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiKeySource()
        Returns:
        Source of the API key for requests. Valid values are `HEADER` (default) and `AUTHORIZER`. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-api-key-source` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.

      • binaryMediaTypes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> binaryMediaTypes()
        Returns:
        List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-binary-media-types` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.

      • body

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> body()
        Returns:
        OpenAPI specification that defines the set of routes and integrations to create as part of the REST API. This configuration, and any updates to it, will replace all REST API configuration except values overridden in this resource configuration and other resource updates applied after this resource but before any `aws.apigateway.Deployment` creation. More information about REST API OpenAPI support can be found in the [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the REST API. If importing an OpenAPI specification via the `body` argument, this corresponds to the `info.description` field. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.

      • disableExecuteApiEndpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> disableExecuteApiEndpoint()
        Returns:
        Whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. Defaults to `false`. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-endpoint-configuration` extension `disableExecuteApiEndpoint` property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html). If the argument value is `true` and is different than the OpenAPI value, the argument value will override the OpenAPI value.

      • endpointAccessMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpointAccessMode()
        Returns:
        Endpoint access mode for the REST API. Valid values are `BASIC` and `STRICT`. Only available for REST APIs that use a `securityPolicy` value beginning with `SecurityPolicy_` and is required when one of those values is configured.

      • endpointConfiguration

        public java.util.Optional<com.pulumi.core.Output<RestApiEndpointConfigurationArgs>> endpointConfiguration()
        Returns:
        Configuration block defining API endpoint configuration including endpoint type. Defined below.

      • failOnWarnings

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> failOnWarnings()
        Returns:
        Whether to return an error for warnings while API Gateway is creating or updating the resource. Defaults to `false`.

      • minimumCompressionSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> minimumCompressionSize()
        Returns:
        Minimum response size to compress for the REST API. String containing an integer value between `-1` and `10485760` (10MB). `-1` will disable an existing compression configuration, and all other values will enable compression with the configured size. New resources can simply omit this argument to disable compression, rather than setting the value to `-1`. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-minimum-compression-size` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-minimum-compression-size.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the REST API. If importing an OpenAPI specification via the `body` argument, this corresponds to the `info.title` field. If the argument value is different than the OpenAPI value, the argument value will override the OpenAPI value.

      • 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, set `ignore` equal to `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).

      • policy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> policy()
        Returns:
        JSON formatted policy document that controls access to the API Gateway. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide. The provider will only perform drift detection of its value when present in a configuration. We recommend using the `aws.apigateway.RestApiPolicy` resource instead. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-policy` extension](https://docs.aws.amazon.com/apigateway/latest/openapi-extensions-policy.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.

      • putRestApiMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> putRestApiMode()
        Returns:
        Mode of the PutRestApi operation when importing an OpenAPI specification via the `body` argument (create or update operation). Valid values are `merge` and `overwrite`. If not configured, defaults to `overwrite` (for backwards compatibility). This corresponds to the [`x-amazon-apigateway-put-integration-method` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-put-integration-method.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.

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

      • securityPolicy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> securityPolicy()
        Returns:
        TLS version + cipher suite for the REST API's default execute-api endpoint. Must be configured for drift detection. When set to a value beginning with `SecurityPolicy_`, `endpointAccessMode` must also be configured. For a list of valid security policies, see [CreateRestApi](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the Amazon API Gateway API Reference.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.