MethodSettings class
Manages API Gateway Stage Method Settings. For example, CloudWatch logging and metrics.
> NOTE: We recommend using this resource in conjunction with the aws.apigateway.Stage resource instead of a stage managed by the aws.apigateway.Deployment resource optional stageName argument. Stages managed by the aws.apigateway.Deployment resource are recreated on redeployment and this resource will require a second apply to recreate the method settings.
Example Usage
End-to-end
Off
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const pathSpecific = new aws.apigateway.MethodSettings("path_specific", {
settings: {
loggingLevel: "OFF",
},
restApi: example.id,
stageName: exampleAwsApiGatewayStage.stageName,
methodPath: "path1/GET",
});
import pulumi
import pulumi_aws as aws
path_specific = aws.apigateway.MethodSettings("path_specific",
settings={
"logging_level": "OFF",
},
rest_api=example["id"],
stage_name=example_aws_api_gateway_stage["stageName"],
method_path="path1/GET")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var pathSpecific = new Aws.ApiGateway.MethodSettings("path_specific", new()
{
Settings = new Aws.ApiGateway.Inputs.MethodSettingsSettingsArgs
{
LoggingLevel = "OFF",
},
RestApi = example.Id,
StageName = exampleAwsApiGatewayStage.StageName,
MethodPath = "path1/GET",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.NewMethodSettings(ctx, "path_specific", &apigateway.MethodSettingsArgs{
Settings: &apigateway.MethodSettingsSettingsArgs{
LoggingLevel: pulumi.String("OFF"),
},
RestApi: pulumi.Any(example.Id),
StageName: pulumi.Any(exampleAwsApiGatewayStage.StageName),
MethodPath: pulumi.String("path1/GET"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_methodsettings" "path_specific" {
settings = {
logging_level = "OFF"
}
rest_api = example.id
stage_name = exampleAwsApiGatewayStage.stageName
method_path = "path1/GET"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.MethodSettings;
import com.pulumi.aws.apigateway.MethodSettingsArgs;
import com.pulumi.aws.apigateway.inputs.MethodSettingsSettingsArgs;
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 pathSpecific = new MethodSettings("pathSpecific", MethodSettingsArgs.builder()
.settings(MethodSettingsSettingsArgs.builder()
.loggingLevel("OFF")
.build())
.restApi(example.id())
.stageName(exampleAwsApiGatewayStage.stageName())
.methodPath("path1/GET")
.build());
}
}
resources:
pathSpecific:
type: aws:apigateway:MethodSettings
name: path_specific
properties:
settings:
loggingLevel: OFF
restApi: ${example.id}
stageName: ${exampleAwsApiGatewayStage.stageName}
methodPath: path1/GET
Errors Only
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const pathSpecific = new aws.apigateway.MethodSettings("path_specific", {
settings: {
loggingLevel: "ERROR",
metricsEnabled: true,
dataTraceEnabled: false,
},
restApi: example.id,
stageName: exampleAwsApiGatewayStage.stageName,
methodPath: "path1/GET",
});
import pulumi
import pulumi_aws as aws
path_specific = aws.apigateway.MethodSettings("path_specific",
settings={
"logging_level": "ERROR",
"metrics_enabled": True,
"data_trace_enabled": False,
},
rest_api=example["id"],
stage_name=example_aws_api_gateway_stage["stageName"],
method_path="path1/GET")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var pathSpecific = new Aws.ApiGateway.MethodSettings("path_specific", new()
{
Settings = new Aws.ApiGateway.Inputs.MethodSettingsSettingsArgs
{
LoggingLevel = "ERROR",
MetricsEnabled = true,
DataTraceEnabled = false,
},
RestApi = example.Id,
StageName = exampleAwsApiGatewayStage.StageName,
MethodPath = "path1/GET",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.NewMethodSettings(ctx, "path_specific", &apigateway.MethodSettingsArgs{
Settings: &apigateway.MethodSettingsSettingsArgs{
LoggingLevel: pulumi.String("ERROR"),
MetricsEnabled: pulumi.Bool(true),
DataTraceEnabled: pulumi.Bool(false),
},
RestApi: pulumi.Any(example.Id),
StageName: pulumi.Any(exampleAwsApiGatewayStage.StageName),
MethodPath: pulumi.String("path1/GET"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_methodsettings" "path_specific" {
settings = {
logging_level = "ERROR"
metrics_enabled = true
data_trace_enabled = false
}
rest_api = example.id
stage_name = exampleAwsApiGatewayStage.stageName
method_path = "path1/GET"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.MethodSettings;
import com.pulumi.aws.apigateway.MethodSettingsArgs;
import com.pulumi.aws.apigateway.inputs.MethodSettingsSettingsArgs;
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 pathSpecific = new MethodSettings("pathSpecific", MethodSettingsArgs.builder()
.settings(MethodSettingsSettingsArgs.builder()
.loggingLevel("ERROR")
.metricsEnabled(true)
.dataTraceEnabled(false)
.build())
.restApi(example.id())
.stageName(exampleAwsApiGatewayStage.stageName())
.methodPath("path1/GET")
.build());
}
}
resources:
pathSpecific:
type: aws:apigateway:MethodSettings
name: path_specific
properties:
settings:
loggingLevel: ERROR
metricsEnabled: true
dataTraceEnabled: false
restApi: ${example.id}
stageName: ${exampleAwsApiGatewayStage.stageName}
methodPath: path1/GET
Errors and Info Logs
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const pathSpecific = new aws.apigateway.MethodSettings("path_specific", {
settings: {
loggingLevel: "INFO",
metricsEnabled: true,
dataTraceEnabled: false,
},
restApi: example.id,
stageName: exampleAwsApiGatewayStage.stageName,
methodPath: "path1/GET",
});
import pulumi
import pulumi_aws as aws
path_specific = aws.apigateway.MethodSettings("path_specific",
settings={
"logging_level": "INFO",
"metrics_enabled": True,
"data_trace_enabled": False,
},
rest_api=example["id"],
stage_name=example_aws_api_gateway_stage["stageName"],
method_path="path1/GET")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var pathSpecific = new Aws.ApiGateway.MethodSettings("path_specific", new()
{
Settings = new Aws.ApiGateway.Inputs.MethodSettingsSettingsArgs
{
LoggingLevel = "INFO",
MetricsEnabled = true,
DataTraceEnabled = false,
},
RestApi = example.Id,
StageName = exampleAwsApiGatewayStage.StageName,
MethodPath = "path1/GET",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.NewMethodSettings(ctx, "path_specific", &apigateway.MethodSettingsArgs{
Settings: &apigateway.MethodSettingsSettingsArgs{
LoggingLevel: pulumi.String("INFO"),
MetricsEnabled: pulumi.Bool(true),
DataTraceEnabled: pulumi.Bool(false),
},
RestApi: pulumi.Any(example.Id),
StageName: pulumi.Any(exampleAwsApiGatewayStage.StageName),
MethodPath: pulumi.String("path1/GET"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_methodsettings" "path_specific" {
settings = {
logging_level = "INFO"
metrics_enabled = true
data_trace_enabled = false
}
rest_api = example.id
stage_name = exampleAwsApiGatewayStage.stageName
method_path = "path1/GET"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.MethodSettings;
import com.pulumi.aws.apigateway.MethodSettingsArgs;
import com.pulumi.aws.apigateway.inputs.MethodSettingsSettingsArgs;
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 pathSpecific = new MethodSettings("pathSpecific", MethodSettingsArgs.builder()
.settings(MethodSettingsSettingsArgs.builder()
.loggingLevel("INFO")
.metricsEnabled(true)
.dataTraceEnabled(false)
.build())
.restApi(example.id())
.stageName(exampleAwsApiGatewayStage.stageName())
.methodPath("path1/GET")
.build());
}
}
resources:
pathSpecific:
type: aws:apigateway:MethodSettings
name: path_specific
properties:
settings:
loggingLevel: INFO
metricsEnabled: true
dataTraceEnabled: false
restApi: ${example.id}
stageName: ${exampleAwsApiGatewayStage.stageName}
methodPath: path1/GET
Full Request and Response Logs
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const pathSpecific = new aws.apigateway.MethodSettings("path_specific", {
settings: {
loggingLevel: "INFO",
metricsEnabled: true,
dataTraceEnabled: true,
},
restApi: example.id,
stageName: exampleAwsApiGatewayStage.stageName,
methodPath: "path1/GET",
});
import pulumi
import pulumi_aws as aws
path_specific = aws.apigateway.MethodSettings("path_specific",
settings={
"logging_level": "INFO",
"metrics_enabled": True,
"data_trace_enabled": True,
},
rest_api=example["id"],
stage_name=example_aws_api_gateway_stage["stageName"],
method_path="path1/GET")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var pathSpecific = new Aws.ApiGateway.MethodSettings("path_specific", new()
{
Settings = new Aws.ApiGateway.Inputs.MethodSettingsSettingsArgs
{
LoggingLevel = "INFO",
MetricsEnabled = true,
DataTraceEnabled = true,
},
RestApi = example.Id,
StageName = exampleAwsApiGatewayStage.StageName,
MethodPath = "path1/GET",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.NewMethodSettings(ctx, "path_specific", &apigateway.MethodSettingsArgs{
Settings: &apigateway.MethodSettingsSettingsArgs{
LoggingLevel: pulumi.String("INFO"),
MetricsEnabled: pulumi.Bool(true),
DataTraceEnabled: pulumi.Bool(true),
},
RestApi: pulumi.Any(example.Id),
StageName: pulumi.Any(exampleAwsApiGatewayStage.StageName),
MethodPath: pulumi.String("path1/GET"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_methodsettings" "path_specific" {
settings = {
logging_level = "INFO"
metrics_enabled = true
data_trace_enabled = true
}
rest_api = example.id
stage_name = exampleAwsApiGatewayStage.stageName
method_path = "path1/GET"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.MethodSettings;
import com.pulumi.aws.apigateway.MethodSettingsArgs;
import com.pulumi.aws.apigateway.inputs.MethodSettingsSettingsArgs;
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 pathSpecific = new MethodSettings("pathSpecific", MethodSettingsArgs.builder()
.settings(MethodSettingsSettingsArgs.builder()
.loggingLevel("INFO")
.metricsEnabled(true)
.dataTraceEnabled(true)
.build())
.restApi(example.id())
.stageName(exampleAwsApiGatewayStage.stageName())
.methodPath("path1/GET")
.build());
}
}
resources:
pathSpecific:
type: aws:apigateway:MethodSettings
name: path_specific
properties:
settings:
loggingLevel: INFO
metricsEnabled: true
dataTraceEnabled: true
restApi: ${example.id}
stageName: ${exampleAwsApiGatewayStage.stageName}
methodPath: path1/GET
Import
Using pulumi import, import aws.apigateway.MethodSettings using REST-API-ID/STAGE-NAME/METHOD-PATH. For example:
$ pulumi import aws:apigateway/methodSettings:MethodSettings example 12345abcde/example/test/GET
Constructors
- MethodSettings(String name, {MethodSettingsArgs? args, CustomResourceOptions? options})
-
Creates a new MethodSettings.
nameThe Pulumi resource name.argsArguments used to configure this MethodSettings. The set of arguments for MethodSettings.optionsResource options controlling this resource's behavior. - MethodSettings.reference(String urn)
- Creates a typed reference to an existing MethodSettings 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
-
methodPath
↔ Output<
String> -
Method path defined as
{resource_path}/{http_method}for an individual method override, or*/*for overriding all methods in the stage. Ensure to trim any leading forward slashes in the path (e.g.,trimprefix(aws_api_gateway_resource.example.path, "/")).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
-
restApi
↔ Output<
String> -
ID of the REST API
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
settings
↔ Output<
MethodSettingsSettings> -
Settings block, see below.
latefinal
-
stageName
↔ Output<
String> -
Name of the stage
latefinal
-
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, {MethodSettingsState? state, CustomResourceOptions? options}) → MethodSettings -
Gets an existing MethodSettings resource's state with the given
nameandid.