Class FolderExclusion


  • public class FolderExclusion
    extends com.pulumi.resources.CustomResource
    Manages a folder-level logging exclusion. For more information see: * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/folders.exclusions) * How-to Guides * [Excluding Logs](https://cloud.google.com/logging/docs/exclusions) > You can specify exclusions for log sinks created by the provider by using the exclusions field of `gcp.logging.FolderSink` ## Example Usage ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.organizations.Folder; import com.pulumi.gcp.organizations.FolderArgs; import com.pulumi.gcp.logging.FolderExclusion; import com.pulumi.gcp.logging.FolderExclusionArgs; 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 my_folder = new Folder("my-folder", FolderArgs.builder() .displayName("My folder") .parent("organizations/123456") .build()); var my_exclusion = new FolderExclusion("my-exclusion", FolderExclusionArgs.builder() .folder(my_folder.name()) .description("Exclude GCE instance debug logs") .filter("resource.type = gce_instance AND severity <= DEBUG") .build()); } } ``` ## Import Folder-level logging exclusions can be imported using their URI, e.g. * `folders/{{folder}}/exclusions/{{name}}` In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import folder-level logging exclusions using one of the formats above. For exampletf import { id = "folders/{{folder}}/exclusions/{{name}}" to = google_logging_folder_exclusion.default } ```sh $ pulumi import gcp:logging/folderExclusion:FolderExclusion When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), folder-level logging exclusions can be imported using one of the formats above. For example ``` ```sh $ pulumi import gcp:logging/folderExclusion:FolderExclusion default folders/{{folder}}/exclusions/{{name}} ```
    • 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
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> disabled()  
      com.pulumi.core.Output<java.lang.String> filter()  
      com.pulumi.core.Output<java.lang.String> folder()  
      static FolderExclusion get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, FolderExclusionState 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> name()  
      • 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

      • FolderExclusion

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

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

        public FolderExclusion​(java.lang.String name,
                               FolderExclusionArgs 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

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        A human-readable description.
      • disabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> disabled()
        Returns:
        Whether this exclusion rule should be disabled or not. This defaults to false.
      • filter

        public com.pulumi.core.Output<java.lang.String> filter()
        Returns:
        The filter to apply when excluding logs. Only log entries that match the filter are excluded. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to write a filter.
      • folder

        public com.pulumi.core.Output<java.lang.String> folder()
        Returns:
        The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is accepted.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the logging exclusion.
      • get

        public static FolderExclusion get​(java.lang.String name,
                                          com.pulumi.core.Output<java.lang.String> id,
                                          @Nullable
                                          FolderExclusionState 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.