Package com.pulumi.aws.apigatewayv2.inputs

Class ApiState

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

    • Nested Class Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiEndpoint()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiKeySelectionExpression()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> body()  
      static ApiState.Builder builder()  
      static ApiState.Builder builder​(ApiState defaults)  
      java.util.Optional<com.pulumi.core.Output<ApiCorsConfigurationArgs>> corsConfiguration()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> credentialsArn()  
      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>> executionArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> failOnWarnings()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> protocolType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> routeKey()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> routeSelectionExpression()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
      Deprecated.
      Please use `tags` instead.
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> target()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> version()  

      • 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 ApiState Empty

    • Method Detail

      • apiEndpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiEndpoint()
        Returns:
        URI of the API, of the form `https://{api-id}.execute-api.{region}.amazonaws.com` for HTTP APIs and `wss://{api-id}.execute-api.{region}.amazonaws.com` for WebSocket APIs.

      • apiKeySelectionExpression

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiKeySelectionExpression()
        Returns:
        An [API key selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). Valid values: `$context.authorizer.usageIdentifierKey`, `$request.header.x-api-key`. Defaults to `$request.header.x-api-key`. Applicable for WebSocket APIs.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the API.

      • body

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> body()
        Returns:
        An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.

      • corsConfiguration

        public java.util.Optional<com.pulumi.core.Output<ApiCorsConfigurationArgs>> corsConfiguration()
        Returns:
        Cross-origin resource sharing (CORS) [configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html). Applicable for HTTP APIs.

      • credentialsArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> credentialsArn()
        Returns:
        Part of _quick create_. Specifies any credentials required for the integration. Applicable for HTTP APIs.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the API. Must be less than or equal to 1024 characters in length.

      • disableExecuteApiEndpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> disableExecuteApiEndpoint()
        Returns:
        Whether clients can invoke the API by using the default `execute-api` endpoint. By default, clients can invoke the API with the default `{api_id}.execute-api.{region}.amazonaws.com endpoint`. To require that clients use a custom domain name to invoke the API, disable the default endpoint.

      • executionArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> executionArn()
        Returns:
        ARN prefix to be used in an `aws.lambda.Permission`'s `source_arn` attribute or in an `aws.iam.Policy` to authorize access to the [`@connections` API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html). See the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-control-access-iam.html) for details.

      • failOnWarnings

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

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the API. Must be less than or equal to 128 characters in length.

      • protocolType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> protocolType()
        Returns:
        API protocol. Valid values: `HTTP`, `WEBSOCKET`.

      • routeKey

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> routeKey()
        Returns:
        Part of _quick create_. Specifies any [route key](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html). Applicable for HTTP APIs.

      • routeSelectionExpression

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> routeSelectionExpression()
        Returns:
        The [route selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-route-selection-expressions) for the API. Defaults to `$request.method $request.path`.

      • tags

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

      • tagsAll

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Deprecated.
        Please use `tags` instead.
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • target

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> target()
        Returns:
        Part of _quick create_. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be `HTTP_PROXY` or `AWS_PROXY`, respectively. Applicable for HTTP APIs.

      • version

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> version()
        Returns:
        Version identifier for the API. Must be between 1 and 64 characters in length.