RestApiPolicy class
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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const testRestApi = new aws.apigateway.RestApi("test", {name: "example-rest-api"});
const test = aws.iam.getPolicyDocumentOutput({
statements: [{
conditions: [{
test: "IpAddress",
variable: "aws:SourceIp",
values: ["123.123.123.123/32"],
}],
principals: [{
type: "AWS",
identifiers: ["*"],
}],
effect: "Allow",
actions: ["execute-api:Invoke"],
resources: [pulumi.interpolate`${testRestApi.executionArn}/*`],
}],
});
const testRestApiPolicy = new aws.apigateway.RestApiPolicy("test", {
restApiId: testRestApi.id,
policy: test.json,
});
import pulumi
import pulumi_aws as aws
test_rest_api = aws.apigateway.RestApi("test", name="example-rest-api")
test = aws.iam.get_policy_document_output(statements=[{
"conditions": [{
"test": "IpAddress",
"variable": "aws:SourceIp",
"values": ["123.123.123.123/32"],
}],
"principals": [{
"type": "AWS",
"identifiers": ["*"],
}],
"effect": "Allow",
"actions": ["execute-api:Invoke"],
"resources": [test_rest_api.execution_arn.apply(lambda execution_arn: f"{execution_arn}/*")],
}])
test_rest_api_policy = aws.apigateway.RestApiPolicy("test",
rest_api_id=test_rest_api.id,
policy=test.json)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var testRestApi = new Aws.ApiGateway.RestApi("test", new()
{
Name = "example-rest-api",
});
var test = Aws.Iam.GetPolicyDocument.Invoke(new()
{
Statements = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Conditions = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
{
Test = "IpAddress",
Variable = "aws:SourceIp",
Values = new[]
{
"123.123.123.123/32",
},
},
},
Principals = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
{
Type = "AWS",
Identifiers = new[]
{
"*",
},
},
},
Effect = "Allow",
Actions = new[]
{
"execute-api:Invoke",
},
Resources = new[]
{
$"{testRestApi.ExecutionArn}/*",
},
},
},
});
var testRestApiPolicy = new Aws.ApiGateway.RestApiPolicy("test", new()
{
RestApiId = testRestApi.Id,
Policy = test.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
testRestApi, err := apigateway.NewRestApi(ctx, "test", &apigateway.RestApiArgs{
Name: pulumi.String("example-rest-api"),
})
if err != nil {
return err
}
test := iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{
Statements: iam.GetPolicyDocumentStatementArray{
&iam.GetPolicyDocumentStatementArgs{
Conditions: iam.GetPolicyDocumentStatementConditionArray{
&iam.GetPolicyDocumentStatementConditionArgs{
Test: pulumi.String("IpAddress"),
Variable: pulumi.String("aws:SourceIp"),
Values: pulumi.StringArray{
pulumi.String("123.123.123.123/32"),
},
},
},
Principals: iam.GetPolicyDocumentStatementPrincipalArray{
&iam.GetPolicyDocumentStatementPrincipalArgs{
Type: pulumi.String("AWS"),
Identifiers: pulumi.StringArray{
pulumi.String("*"),
},
},
},
Effect: pulumi.String("Allow"),
Actions: pulumi.StringArray{
pulumi.String("execute-api:Invoke"),
},
Resources: pulumi.StringArray{
testRestApi.ExecutionArn.ApplyT(func(executionArn string) (string, error) {
return fmt.Sprintf("%v/*", executionArn), nil
}).(pulumi.StringOutput),
},
},
},
}, nil)
_, err = apigateway.NewRestApiPolicy(ctx, "test", &apigateway.RestApiPolicyArgs{
RestApiId: testRestApi.ID().ToIDOutput().ToStringOutput(),
Policy: test.Json(),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_iam_getpolicydocument" "test" {
statements {
conditions {
test = "IpAddress"
variable = "aws:SourceIp"
values = ["123.123.123.123/32"]
}
principals {
type = "AWS"
identifiers = ["*"]
}
effect = "Allow"
actions = ["execute-api:Invoke"]
resources = ["${aws_apigateway_restapi.test.execution_arn}/*"]
}
}
resource "aws_apigateway_restapi" "test" {
name = "example-rest-api"
}
resource "aws_apigateway_restapipolicy" "test" {
rest_api_id = aws_apigateway_restapi.test.id
policy = data.aws_iam_getpolicydocument.test.json
}
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.RestApiArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementConditionArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
import com.pulumi.aws.apigateway.RestApiPolicy;
import com.pulumi.aws.apigateway.RestApiPolicyArgs;
import java.util.ArrayList;
import java.util.Arrays;
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", RestApiArgs.builder()
.name("example-rest-api")
.build());
final var test = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
.statements(GetPolicyDocumentStatementArgs.builder()
.conditions(GetPolicyDocumentStatementConditionArgs.builder()
.test("IpAddress")
.variable("aws:SourceIp")
.values("123.123.123.123/32")
.build())
.principals(GetPolicyDocumentStatementPrincipalArgs.builder()
.type("AWS")
.identifiers("*")
.build())
.effect("Allow")
.actions("execute-api:Invoke")
.resources(testRestApi.executionArn().applyValue(_executionArn -> String.format("%s/*", _executionArn)))
.build())
.build());
var testRestApiPolicy = new RestApiPolicy("testRestApiPolicy", RestApiPolicyArgs.builder()
.restApiId(testRestApi.id())
.policy(test.applyValue(_test -> _test.json()))
.build());
}
}
resources:
testRestApi:
type: aws:apigateway:RestApi
name: test
properties:
name: example-rest-api
testRestApiPolicy:
type: aws:apigateway:RestApiPolicy
name: test
properties:
restApiId: ${testRestApi.id}
policy: ${test.json}
variables:
test:
fn::invoke:
function: aws:iam:getPolicyDocument
arguments:
statements:
- conditions:
- test: IpAddress
variable: aws:SourceIp
values:
- 123.123.123.123/32
principals:
- type: AWS
identifiers:
- '*'
effect: Allow
actions:
- execute-api:Invoke
resources:
- ${testRestApi.executionArn}/*
Import
Using pulumi import, import aws.apigateway.RestApiPolicy using the REST API ID. For example:
$ pulumi import aws:apigateway/restApiPolicy:RestApiPolicy example 12345abcde
Constructors
- RestApiPolicy(String name, {RestApiPolicyArgs? args, CustomResourceOptions? options})
-
Creates a new RestApiPolicy.
nameThe Pulumi resource name.argsArguments used to configure this RestApiPolicy. The set of arguments for RestApiPolicy.optionsResource options controlling this resource's behavior. - RestApiPolicy.reference(String urn)
- Creates a typed reference to an existing RestApiPolicy resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
policy
↔ Output<
String> -
JSON formatted policy document that controls access to the API Gateway.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
restApiId
↔ Output<
String> -
ID of the REST API.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {RestApiPolicyState? state, CustomResourceOptions? options}) → RestApiPolicy -
Gets an existing RestApiPolicy resource's state with the given
nameandid.