1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. logging
  5. ProjectSink
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.logging.ProjectSink

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    Import

    Project-level logging sinks can be imported using their URI, e.g.

    • projects/{{project_id}}/sinks/{{name}}

    When using the pulumi import command, project-level logging sinks can be imported using one of the formats above. For example:

    $ pulumi import gcp:logging/projectSink:ProjectSink default projects/{{project_id}}/sinks/{{name}}
    

    Create ProjectSink Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProjectSink(name: string, args: ProjectSinkArgs, opts?: CustomResourceOptions);
    @overload
    def ProjectSink(resource_name: str,
                    args: ProjectSinkArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProjectSink(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    destination: Optional[str] = None,
                    bigquery_options: Optional[ProjectSinkBigqueryOptionsArgs] = None,
                    custom_writer_identity: Optional[str] = None,
                    description: Optional[str] = None,
                    disabled: Optional[bool] = None,
                    exclusions: Optional[Sequence[ProjectSinkExclusionArgs]] = None,
                    filter: Optional[str] = None,
                    name: Optional[str] = None,
                    project: Optional[str] = None,
                    unique_writer_identity: Optional[bool] = None)
    func NewProjectSink(ctx *Context, name string, args ProjectSinkArgs, opts ...ResourceOption) (*ProjectSink, error)
    public ProjectSink(string name, ProjectSinkArgs args, CustomResourceOptions? opts = null)
    public ProjectSink(String name, ProjectSinkArgs args)
    public ProjectSink(String name, ProjectSinkArgs args, CustomResourceOptions options)
    
    type: gcp:logging:ProjectSink
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProjectSinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProjectSinkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProjectSinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectSinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectSinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var projectSinkResource = new Gcp.Logging.ProjectSink("projectSinkResource", new()
    {
        Destination = "string",
        BigqueryOptions = new Gcp.Logging.Inputs.ProjectSinkBigqueryOptionsArgs
        {
            UsePartitionedTables = false,
        },
        CustomWriterIdentity = "string",
        Description = "string",
        Disabled = false,
        Exclusions = new[]
        {
            new Gcp.Logging.Inputs.ProjectSinkExclusionArgs
            {
                Filter = "string",
                Name = "string",
                Description = "string",
                Disabled = false,
            },
        },
        Filter = "string",
        Name = "string",
        Project = "string",
        UniqueWriterIdentity = false,
    });
    
    example, err := logging.NewProjectSink(ctx, "projectSinkResource", &logging.ProjectSinkArgs{
    	Destination: pulumi.String("string"),
    	BigqueryOptions: &logging.ProjectSinkBigqueryOptionsArgs{
    		UsePartitionedTables: pulumi.Bool(false),
    	},
    	CustomWriterIdentity: pulumi.String("string"),
    	Description:          pulumi.String("string"),
    	Disabled:             pulumi.Bool(false),
    	Exclusions: logging.ProjectSinkExclusionArray{
    		&logging.ProjectSinkExclusionArgs{
    			Filter:      pulumi.String("string"),
    			Name:        pulumi.String("string"),
    			Description: pulumi.String("string"),
    			Disabled:    pulumi.Bool(false),
    		},
    	},
    	Filter:               pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    	Project:              pulumi.String("string"),
    	UniqueWriterIdentity: pulumi.Bool(false),
    })
    
    var projectSinkResource = new ProjectSink("projectSinkResource", ProjectSinkArgs.builder()
        .destination("string")
        .bigqueryOptions(ProjectSinkBigqueryOptionsArgs.builder()
            .usePartitionedTables(false)
            .build())
        .customWriterIdentity("string")
        .description("string")
        .disabled(false)
        .exclusions(ProjectSinkExclusionArgs.builder()
            .filter("string")
            .name("string")
            .description("string")
            .disabled(false)
            .build())
        .filter("string")
        .name("string")
        .project("string")
        .uniqueWriterIdentity(false)
        .build());
    
    project_sink_resource = gcp.logging.ProjectSink("projectSinkResource",
        destination="string",
        bigquery_options=gcp.logging.ProjectSinkBigqueryOptionsArgs(
            use_partitioned_tables=False,
        ),
        custom_writer_identity="string",
        description="string",
        disabled=False,
        exclusions=[gcp.logging.ProjectSinkExclusionArgs(
            filter="string",
            name="string",
            description="string",
            disabled=False,
        )],
        filter="string",
        name="string",
        project="string",
        unique_writer_identity=False)
    
    const projectSinkResource = new gcp.logging.ProjectSink("projectSinkResource", {
        destination: "string",
        bigqueryOptions: {
            usePartitionedTables: false,
        },
        customWriterIdentity: "string",
        description: "string",
        disabled: false,
        exclusions: [{
            filter: "string",
            name: "string",
            description: "string",
            disabled: false,
        }],
        filter: "string",
        name: "string",
        project: "string",
        uniqueWriterIdentity: false,
    });
    
    type: gcp:logging:ProjectSink
    properties:
        bigqueryOptions:
            usePartitionedTables: false
        customWriterIdentity: string
        description: string
        destination: string
        disabled: false
        exclusions:
            - description: string
              disabled: false
              filter: string
              name: string
        filter: string
        name: string
        project: string
        uniqueWriterIdentity: false
    

    ProjectSink Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ProjectSink resource accepts the following input properties:

    Destination string

    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, a Cloud Logging bucket, or a Google Cloud project. 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.

    BigqueryOptions ProjectSinkBigqueryOptions
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    CustomWriterIdentity string
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    Description string
    A description of this sink. The maximum length of the description is 8000 characters.
    Disabled bool
    If set to True, then this sink is disabled and it does not export any log entries.
    Exclusions List<ProjectSinkExclusion>
    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 string
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    Name string
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    Project string
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    UniqueWriterIdentity bool
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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.
    Destination string

    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, a Cloud Logging bucket, or a Google Cloud project. 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.

    BigqueryOptions ProjectSinkBigqueryOptionsArgs
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    CustomWriterIdentity string
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    Description string
    A description of this sink. The maximum length of the description is 8000 characters.
    Disabled bool
    If set to True, then this sink is disabled and it does not export any log entries.
    Exclusions []ProjectSinkExclusionArgs
    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 string
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    Name string
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    Project string
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    UniqueWriterIdentity bool
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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.
    destination String

    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, a Cloud Logging bucket, or a Google Cloud project. 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.

    bigqueryOptions ProjectSinkBigqueryOptions
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    customWriterIdentity String
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    description String
    A description of this sink. The maximum length of the description is 8000 characters.
    disabled Boolean
    If set to True, then this sink is disabled and it does not export any log entries.
    exclusions List<ProjectSinkExclusion>
    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 String
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    name String
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    project String
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    uniqueWriterIdentity Boolean
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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.
    destination string

    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, a Cloud Logging bucket, or a Google Cloud project. 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.

    bigqueryOptions ProjectSinkBigqueryOptions
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    customWriterIdentity string
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    description string
    A description of this sink. The maximum length of the description is 8000 characters.
    disabled boolean
    If set to True, then this sink is disabled and it does not export any log entries.
    exclusions ProjectSinkExclusion[]
    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 string
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    name string
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    project string
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    uniqueWriterIdentity boolean
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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.
    destination str

    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, a Cloud Logging bucket, or a Google Cloud project. 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.

    bigquery_options ProjectSinkBigqueryOptionsArgs
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    custom_writer_identity str
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    description str
    A description of this sink. The maximum length of the description is 8000 characters.
    disabled bool
    If set to True, then this sink is disabled and it does not export any log entries.
    exclusions Sequence[ProjectSinkExclusionArgs]
    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 str
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    name str
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    project str
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    unique_writer_identity bool
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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.
    destination String

    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, a Cloud Logging bucket, or a Google Cloud project. 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.

    bigqueryOptions Property Map
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    customWriterIdentity String
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    description String
    A description of this sink. The maximum length of the description is 8000 characters.
    disabled Boolean
    If set to True, then this sink is disabled and it does not export any log entries.
    exclusions List<Property Map>
    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 String
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    name String
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    project String
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    uniqueWriterIdentity Boolean
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProjectSink resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    WriterIdentity string
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    WriterIdentity string
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    id String
    The provider-assigned unique ID for this managed resource.
    writerIdentity String
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    id string
    The provider-assigned unique ID for this managed resource.
    writerIdentity string
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    id str
    The provider-assigned unique ID for this managed resource.
    writer_identity str
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    id String
    The provider-assigned unique ID for this managed resource.
    writerIdentity String
    The identity associated with this sink. This identity must be granted write access to the configured destination.

    Look up Existing ProjectSink Resource

    Get an existing ProjectSink resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProjectSinkState, opts?: CustomResourceOptions): ProjectSink
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bigquery_options: Optional[ProjectSinkBigqueryOptionsArgs] = None,
            custom_writer_identity: Optional[str] = None,
            description: Optional[str] = None,
            destination: Optional[str] = None,
            disabled: Optional[bool] = None,
            exclusions: Optional[Sequence[ProjectSinkExclusionArgs]] = None,
            filter: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            unique_writer_identity: Optional[bool] = None,
            writer_identity: Optional[str] = None) -> ProjectSink
    func GetProjectSink(ctx *Context, name string, id IDInput, state *ProjectSinkState, opts ...ResourceOption) (*ProjectSink, error)
    public static ProjectSink Get(string name, Input<string> id, ProjectSinkState? state, CustomResourceOptions? opts = null)
    public static ProjectSink get(String name, Output<String> id, ProjectSinkState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BigqueryOptions ProjectSinkBigqueryOptions
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    CustomWriterIdentity string
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    Description string
    A description of this sink. The maximum length of the description is 8000 characters.
    Destination string

    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, a Cloud Logging bucket, or a Google Cloud project. 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 bool
    If set to True, then this sink is disabled and it does not export any log entries.
    Exclusions List<ProjectSinkExclusion>
    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 string
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    Name string
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    Project string
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    UniqueWriterIdentity bool
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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 string
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    BigqueryOptions ProjectSinkBigqueryOptionsArgs
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    CustomWriterIdentity string
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    Description string
    A description of this sink. The maximum length of the description is 8000 characters.
    Destination string

    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, a Cloud Logging bucket, or a Google Cloud project. 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 bool
    If set to True, then this sink is disabled and it does not export any log entries.
    Exclusions []ProjectSinkExclusionArgs
    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 string
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    Name string
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    Project string
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    UniqueWriterIdentity bool
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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 string
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    bigqueryOptions ProjectSinkBigqueryOptions
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    customWriterIdentity String
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    description String
    A description of this sink. The maximum length of the description is 8000 characters.
    destination String

    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, a Cloud Logging bucket, or a Google Cloud project. 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 Boolean
    If set to True, then this sink is disabled and it does not export any log entries.
    exclusions List<ProjectSinkExclusion>
    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 String
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    name String
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    project String
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    uniqueWriterIdentity Boolean
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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 String
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    bigqueryOptions ProjectSinkBigqueryOptions
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    customWriterIdentity string
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    description string
    A description of this sink. The maximum length of the description is 8000 characters.
    destination string

    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, a Cloud Logging bucket, or a Google Cloud project. 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 boolean
    If set to True, then this sink is disabled and it does not export any log entries.
    exclusions ProjectSinkExclusion[]
    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 string
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    name string
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    project string
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    uniqueWriterIdentity boolean
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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 string
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    bigquery_options ProjectSinkBigqueryOptionsArgs
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    custom_writer_identity str
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    description str
    A description of this sink. The maximum length of the description is 8000 characters.
    destination str

    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, a Cloud Logging bucket, or a Google Cloud project. 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 bool
    If set to True, then this sink is disabled and it does not export any log entries.
    exclusions Sequence[ProjectSinkExclusionArgs]
    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 str
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    name str
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    project str
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    unique_writer_identity bool
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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.
    writer_identity str
    The identity associated with this sink. This identity must be granted write access to the configured destination.
    bigqueryOptions Property Map
    Options that affect sinks exporting data to BigQuery. Structure documented below.
    customWriterIdentity String
    A user managed service account that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
    description String
    A description of this sink. The maximum length of the description is 8000 characters.
    destination String

    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, a Cloud Logging bucket, or a Google Cloud project. 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 Boolean
    If set to True, then this sink is disabled and it does not export any log entries.
    exclusions List<Property Map>
    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 String
    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.
    name String
    The name of the logging sink. Logging automatically creates two sinks: _Required and _Default.
    project String
    The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
    uniqueWriterIdentity Boolean
    Whether or not to create a unique identity associated with this sink. If false, then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true (the default), 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 String
    The identity associated with this sink. This identity must be granted write access to the configured destination.

    Supporting Types

    ProjectSinkBigqueryOptions, ProjectSinkBigqueryOptionsArgs

    UsePartitionedTables bool
    Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
    UsePartitionedTables bool
    Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
    usePartitionedTables Boolean
    Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
    usePartitionedTables boolean
    Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
    use_partitioned_tables bool
    Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.
    usePartitionedTables Boolean
    Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

    ProjectSinkExclusion, ProjectSinkExclusionArgs

    Filter string
    An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. See Advanced Log Filters for information on how to write a filter.
    Name string
    A client-assigned identifier, such as load-balancer-exclusion. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
    Description string
    A description of this exclusion.
    Disabled bool
    If set to True, then this exclusion is disabled and it does not exclude any log entries.
    Filter string
    An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. See Advanced Log Filters for information on how to write a filter.
    Name string
    A client-assigned identifier, such as load-balancer-exclusion. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
    Description string
    A description of this exclusion.
    Disabled bool
    If set to True, then this exclusion is disabled and it does not exclude any log entries.
    filter String
    An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. See Advanced Log Filters for information on how to write a filter.
    name String
    A client-assigned identifier, such as load-balancer-exclusion. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
    description String
    A description of this exclusion.
    disabled Boolean
    If set to True, then this exclusion is disabled and it does not exclude any log entries.
    filter string
    An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. See Advanced Log Filters for information on how to write a filter.
    name string
    A client-assigned identifier, such as load-balancer-exclusion. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
    description string
    A description of this exclusion.
    disabled boolean
    If set to True, then this exclusion is disabled and it does not exclude any log entries.
    filter str
    An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. See Advanced Log Filters for information on how to write a filter.
    name str
    A client-assigned identifier, such as load-balancer-exclusion. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
    description str
    A description of this exclusion.
    disabled bool
    If set to True, then this exclusion is disabled and it does not exclude any log entries.
    filter String
    An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. See Advanced Log Filters for information on how to write a filter.
    name String
    A client-assigned identifier, such as load-balancer-exclusion. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
    description String
    A description of this exclusion.
    disabled Boolean
    If set to True, then this exclusion is disabled and it does not exclude any log entries.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi