Package com.pulumi.aws.apigateway

Class MethodSettings

  • public class MethodSettings
extends com.pulumi.resources.CustomResource
    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 
     
 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());
 
     }
 }
    ### Errors Only 
     
 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());
 
     }
 }
    ### Errors and Info Logs 
     
 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());
 
     }
 }
    ### Full Request and Response Logs 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.apigateway.MethodSettings` using `REST-API-ID/STAGE-NAME/METHOD-PATH`. For example: ```sh $ pulumi import aws:apigateway/methodSettings:MethodSettings example 12345abcde/example/test/GET ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static MethodSettings get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, MethodSettingsState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> methodPath()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> restApi()  
      com.pulumi.core.Output<MethodSettingsSettings> settings()  
      com.pulumi.core.Output<java.lang.String> stageName()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MethodSettings

        public MethodSettings​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • MethodSettings

        public MethodSettings​(java.lang.String name,
                      MethodSettingsArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • MethodSettings

        public MethodSettings​(java.lang.String name,
                      MethodSettingsArgs args,
                      @Nullable
                      com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • methodPath

        public com.pulumi.core.Output<java.lang.String> methodPath()
        Returns:
        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, "/")`).

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • restApi

        public com.pulumi.core.Output<java.lang.String> restApi()
        Returns:
        ID of the REST API

      • settings

        public com.pulumi.core.Output<MethodSettingsSettings> settings()
        Returns:
        Settings block, see below.

      • stageName

        public com.pulumi.core.Output<java.lang.String> stageName()
        Returns:
        Name of the stage

      • get

        public static MethodSettings get​(java.lang.String name,
                                 com.pulumi.core.Output<java.lang.String> id,
                                 @Nullable
                                 MethodSettingsState state,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.