Package com.pulumi.gcp.logging

Class ProjectSink

  • public class ProjectSink
extends com.pulumi.resources.CustomResource
    ## Import Project-level logging sinks can be imported using their URI, e.g. ```sh $ pulumi import gcp:logging/projectSink:ProjectSink my_sink projects/my-project/sinks/my-sink ```

    • 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<ProjectSinkBigqueryOptions> bigqueryOptions()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> destination()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> disabled()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<ProjectSinkExclusion>>> exclusions()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> filter()  
      static ProjectSink get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ProjectSinkState 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()  
      com.pulumi.core.Output<java.lang.String> project()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> uniqueWriterIdentity()  
      com.pulumi.core.Output<java.lang.String> writerIdentity()  

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

        getId, idFuture

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

        getChildResources, getResourceName, getResourceType, getUrn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ProjectSink

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

      • ProjectSink

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

      • ProjectSink

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

      • bigqueryOptions

        public com.pulumi.core.Output<ProjectSinkBigqueryOptions> bigqueryOptions()
        Returns:
        Options that affect sinks exporting data to BigQuery. Structure documented below.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        A description of this sink. The maximum length of the description is 8000 characters.

      • destination

        public com.pulumi.core.Output<java.lang.String> destination()
        Returns:
        The destination of the sink (or, in other words, where logs are written to). Can be a Cloud Storage bucket, a PubSub topic, a BigQuery dataset or a Cloud Logging bucket . Examples: - `storage.googleapis.com/[GCS_BUCKET]` - `bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]` - `pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]` - `logging.googleapis.com/projects/[PROJECT_ID]/locations/global/buckets/[BUCKET_ID]` - `logging.googleapis.com/projects/[PROJECT_ID]` The writer associated with the sink must have access to write to the above resource.

      • disabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> disabled()
        Returns:
        If set to True, then this sink is disabled and it does not export any log entries.

      • exclusions

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ProjectSinkExclusion>>> exclusions()
        Returns:
        Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both `filter` and one of `exclusions.filter`, it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is documented below.

      • filter

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> filter()
        Returns:
        The filter to apply when exporting logs. Only log entries that match the filter are exported. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to write a filter.

      • name

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

      • project

        public com.pulumi.core.Output<java.lang.String> project()
        Returns:
        The ID of the project to create the sink in. If omitted, the project associated with the provider is used.

      • uniqueWriterIdentity

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> uniqueWriterIdentity()
        Returns:
        Whether or not to create a unique identity associated with this sink. If `false` (the default), then the `writer_identity` used is `serviceAccount:[email protected]`. If `true`, then a unique service account is created and used for this sink. If you wish to publish logs across projects or utilize `bigquery_options`, you must set `unique_writer_identity` to true.

      • writerIdentity

        public com.pulumi.core.Output<java.lang.String> writerIdentity()
        Returns:
        The identity associated with this sink. This identity must be granted write access to the configured `destination`.

      • get

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