RestApiPolicy

Provides an API Gateway REST API Policy.

Note: Amazon API Gateway Version 1 resources are used for creating and deploying REST APIs. To create and deploy WebSocket and HTTP APIs, use Amazon API Gateway Version 2 resources.

Example Usage

Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.RestApi;
import com.pulumi.aws.apigateway.RestApiPolicy;
import com.pulumi.aws.apigateway.RestApiPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testRestApi = new RestApi("testRestApi");
var testRestApiPolicy = new RestApiPolicy("testRestApiPolicy", RestApiPolicyArgs.builder()
.restApiId(testRestApi.id())
.policy(testRestApi.executionArn().applyValue(executionArn -> """
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "*"
},
"Action": "execute-api:Invoke",
"Resource": "%s",
"Condition": {
"IpAddress": {
"aws:SourceIp": "123.123.123.123/32"
}
}
}
]
}
", executionArn)))
.build());
}
}

Import

aws_api_gateway_rest_api_policy can be imported by using the REST API ID, e.g.,

$ pulumi import aws:apigateway/restApiPolicy:RestApiPolicy example 12345abcde

Properties

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val policy: Output<String>

JSON formatted policy document that controls access to the API Gateway.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val restApiId: Output<String>

ID of the REST API.

Link copied to clipboard
val urn: Output<String>