Ctrl + k

or run

tessl search
Log in

Version

Workspace
tessl
Visibility
Public
Created
Last updated
Describes
mavenpkg:maven/com.pulumi/aws@7.16.x

docs

services

networking

api-gateway.mdcloudfront.mddirect-connect.mdindex.mdload-balancers.mdroute53.mdtransit-gateway.mdvpc.mdvpn.md
additional-services.mdanalytics.mdcontainer-services.mddeveloper-tools.mdintegration.mdmanagement.mdml-ai.md
common-patterns.mdgetting-started.mdindex.mdprovider.md
tile.json

tessl/maven-com-pulumi--aws

tessl install tessl/maven-com-pulumi--aws@7.16.0

Pulumi Java SDK for AWS providing strongly-typed Infrastructure-as-Code for 227 AWS service packages including compute, storage, databases, networking, security, analytics, machine learning, and more.

api-gateway.mddocs/services/networking/

API Gateway

AWS API Gateway provides REST API (v1) and HTTP API (v2) services.

AWS API Gateway provides REST API (v1) and HTTP API (v2) services.

REST API (API Gateway v1)

import com.pulumi.aws.apigateway.RestApi;
import com.pulumi.aws.apigateway.RestApiArgs;
import com.pulumi.aws.apigateway.Resource;
import com.pulumi.aws.apigateway.ResourceArgs;
import com.pulumi.aws.apigateway.Method;
import com.pulumi.aws.apigateway.MethodArgs;
import com.pulumi.aws.apigateway.Integration;
import com.pulumi.aws.apigateway.IntegrationArgs;
import com.pulumi.aws.apigateway.Deployment;
import com.pulumi.aws.apigateway.DeploymentArgs;
import com.pulumi.aws.apigateway.Stage;
import com.pulumi.aws.apigateway.StageArgs;

RestApi Resource

@ResourceType(type="aws:apigateway/restApi:RestApi")
public class RestApi extends com.pulumi.resources.CustomResource {
    public RestApi(String name);
    public RestApi(String name, @Nullable RestApiArgs args);
    public RestApi(String name, @Nullable RestApiArgs args, @Nullable CustomResourceOptions options);

    // Exported Properties
    public Output<String> id();
    public Output<String> arn();
    public Output<String> name();
    public Output<Optional<String>> description();
    public Output<String> createdDate();
    public Output<String> executionArn();
    public Output<String> rootResourceId();
    public Output<Optional<List<String>>> apiKeySource();
    public Output<Optional<List<String>>> binaryMediaTypes();
    public Output<Optional<RestApiEndpointConfiguration>> endpointConfiguration();
    public Output<Optional<String>> minimumCompressionSize();
    public Output<Optional<String>> policy();
    public Output<Optional<Map<String, String>>> tags();
    public Output<Map<String, String>> tagsAll();
}

public class RestApiArgs extends com.pulumi.resources.ResourceArgs {
    public static Builder builder() { return new Builder(); }

    public static final class Builder {
        public Builder name(Output<String> name);
        public Builder description(Output<String> description);
        public Builder apiKeySource(Output<String> apiKeySource);
        public Builder binaryMediaTypes(Output<List<String>> binaryMediaTypes);
        public Builder endpointConfiguration(Output<RestApiEndpointConfigurationArgs> endpointConfiguration);
        public Builder minimumCompressionSize(Output<Integer> minimumCompressionSize);
        public Builder policy(Output<String> policy);
        public Builder body(Output<String> body);
        public Builder disableExecuteApiEndpoint(Output<Boolean> disableExecuteApiEndpoint);
        public Builder failOnWarnings(Output<Boolean> failOnWarnings);
        public Builder parameters(Output<Map<String, String>> parameters);
        public Builder putRestApiMode(Output<String> putRestApiMode);
        public Builder tags(Output<Map<String, String>> tags);

        public RestApiArgs build();
    }
}

HTTP API (API Gateway v2)

import com.pulumi.aws.apigatewayv2.Api;
import com.pulumi.aws.apigatewayv2.ApiArgs;
import com.pulumi.aws.apigatewayv2.Route;
import com.pulumi.aws.apigatewayv2.RouteArgs;
import com.pulumi.aws.apigatewayv2.Integration;
import com.pulumi.aws.apigatewayv2.IntegrationArgs;
import com.pulumi.aws.apigatewayv2.Stage;
import com.pulumi.aws.apigatewayv2.StageArgs;
import com.pulumi.aws.apigatewayv2.Authorizer;
import com.pulumi.aws.apigatewayv2.AuthorizerArgs;

Api Resource (v2)

@ResourceType(type="aws:apigatewayv2/api:Api")
public class Api extends com.pulumi.resources.CustomResource {
    public Api(String name, ApiArgs args);
    public Api(String name, ApiArgs args, @Nullable CustomResourceOptions options);

    // Exported Properties
    public Output<String> id();
    public Output<String> arn();
    public Output<String> apiEndpoint();
    public Output<String> apiKeySelectionExpression();
    public Output<String> executionArn();
    public Output<String> name();
    public Output<String> protocolType();
    public Output<Optional<String>> body();
    public Output<Optional<ApiCorsConfiguration>> corsConfiguration();
    public Output<Optional<String>> credentialsArn();
    public Output<Optional<String>> description();
    public Output<Optional<Boolean>> disableExecuteApiEndpoint();
    public Output<Optional<String>> routeKey();
    public Output<Optional<String>> routeSelectionExpression();
    public Output<Optional<String>> target();
    public Output<Optional<String>> version();
    public Output<Optional<Map<String, String>>> tags();
    public Output<Map<String, String>> tagsAll();
}

public class ApiArgs extends com.pulumi.resources.ResourceArgs {
    public static Builder builder() { return new Builder(); }

    public static final class Builder {
        // Required
        public Builder name(Output<String> name);
        public Builder protocolType(Output<String> protocolType); // "HTTP", "WEBSOCKET"

        // Configuration
        public Builder apiKeySelectionExpression(Output<String> apiKeySelectionExpression);
        public Builder corsConfiguration(Output<ApiCorsConfigurationArgs> corsConfiguration);
        public Builder credentialsArn(Output<String> credentialsArn);
        public Builder description(Output<String> description);
        public Builder disableExecuteApiEndpoint(Output<Boolean> disableExecuteApiEndpoint);
        public Builder routeKey(Output<String> routeKey);
        public Builder routeSelectionExpression(Output<String> routeSelectionExpression);
        public Builder target(Output<String> target);
        public Builder version(Output<String> version);
        public Builder body(Output<String> body);
        public Builder failOnWarnings(Output<Boolean> failOnWarnings);

        // Tags
        public Builder tags(Output<Map<String, String>> tags);

        public ApiArgs build();
    }
}