Package com.pulumi.aws.apigatewayv2.outputs

Class GetApiResult

  • public final class GetApiResult
extends java.lang.Object

    • Method Detail

      • apiEndpoint

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

      • apiId

        public java.lang.String apiId()

      • apiKeySelectionExpression

        public java.lang.String apiKeySelectionExpression()
        Returns:
        [API key selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). Applicable for WebSocket APIs.

      • arn

        public java.lang.String arn()
        Returns:
        ARN of the API.

      • corsConfigurations

        public java.util.List<GetApiCorsConfiguration> corsConfigurations()
        Returns:
        Cross-origin resource sharing (CORS) [configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html). Applicable for HTTP APIs. See below.

      • description

        public java.lang.String description()
        Returns:
        Description of the API.

      • disableExecuteApiEndpoint

        public java.lang.Boolean disableExecuteApiEndpoint()
        Returns:
        Whether clients can invoke the API by using the default `execute-api` endpoint.

      • executionArn

        public java.lang.String executionArn()
        Returns:
        ARN prefix to be used in an `aws.lambda.Permission`'s `sourceArn` 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.

      • id

        public java.lang.String id()
        Returns:
        The provider-assigned unique ID for this managed resource.

      • ipAddressType

        public java.lang.String ipAddressType()
        Returns:
        IP address types that can invoke an API.

      • name

        public java.lang.String name()
        Returns:
        Name of the API.

      • protocolType

        public java.lang.String protocolType()
        Returns:
        API protocol.

      • region

        public java.lang.String region()

      • routeSelectionExpression

        public java.lang.String routeSelectionExpression()
        Returns:
        [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.

      • tags

        public java.util.Map<java.lang.String,​java.lang.String> tags()
        Returns:
        Map of resource tags.

      • version

        public java.lang.String version()
        Returns:
        Version identifier for the API.