Package com.pulumi.aws.apigateway.outputs

Class GetRestApiResult

  • public final class GetRestApiResult
extends java.lang.Object

    • Method Detail

      • apiKeySource

        public java.lang.String apiKeySource()
        Returns:
        Source of the API key for requests.

      • arn

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

      • binaryMediaTypes

        public java.util.List<java.lang.String> binaryMediaTypes()
        Returns:
        List of binary media types supported by the REST API.

      • description

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

      • endpointAccessMode

        public java.lang.String endpointAccessMode()
        Returns:
        Endpoint access mode for the REST API.

      • endpointConfigurations

        public java.util.List<GetRestApiEndpointConfiguration> endpointConfigurations()
        Returns:
        Endpoint configuration of this REST API showing the endpoint types of the API. See below.

      • executionArn

        public java.lang.String executionArn()
        Returns:
        Execution ARN part to be used in `lambdaPermission`'s `sourceArn` when allowing API Gateway to invoke a Lambda function, e.g., `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j`, which can be concatenated with allowed stage, method and resource path.

      • id

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

      • minimumCompressionSize

        public java.lang.String minimumCompressionSize()
        Returns:
        Minimum response size to compress for the REST API.

      • name

        public java.lang.String name()

      • policy

        public java.lang.String policy()
        Returns:
        JSON formatted policy document that controls access to the API Gateway.

      • region

        public java.lang.String region()

      • rootResourceId

        public java.lang.String rootResourceId()
        Returns:
        Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.

      • securityPolicy

        public java.lang.String securityPolicy()
        Returns:
        TLS version + cipher suite for the REST API's default execute-api endpoint.

      • tags

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