Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sumologic Provider
  3. API Docs
  4. GcpMetricsSource
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-sumologic

sumologic.GcpMetricsSource

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-sumologic

    Provides a Sumologic GCP Metrics Source

    IMPORTANT: The Service Account parameters (including private key) are stored in plain-text in the state. This is a potential security issue.

    Create GcpMetricsSource Resource

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

    Constructor syntax

    new GcpMetricsSource(name: string, args: GcpMetricsSourceArgs, opts?: CustomResourceOptions);
    @overload
def GcpMetricsSource(resource_name: str,
                     args: GcpMetricsSourceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def GcpMetricsSource(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     content_type: Optional[str] = None,
                     path: Optional[GcpMetricsSourcePathArgs] = None,
                     authentication: Optional[GcpMetricsSourceAuthenticationArgs] = None,
                     collector_id: Optional[int] = None,
                     filters: Optional[Sequence[GcpMetricsSourceFilterArgs]] = None,
                     host_name: Optional[str] = None,
                     cutoff_timestamp: Optional[int] = None,
                     default_date_formats: Optional[Sequence[GcpMetricsSourceDefaultDateFormatArgs]] = None,
                     description: Optional[str] = None,
                     fields: Optional[Mapping[str, str]] = None,
                     category: Optional[str] = None,
                     force_timezone: Optional[bool] = None,
                     hash_algorithm: Optional[str] = None,
                     cutoff_relative_time: Optional[str] = None,
                     manual_prefix_regexp: Optional[str] = None,
                     multiline_processing_enabled: Optional[bool] = None,
                     name: Optional[str] = None,
                     automatic_date_parsing: Optional[bool] = None,
                     paused: Optional[bool] = None,
                     scan_interval: Optional[int] = None,
                     timezone: Optional[str] = None,
                     use_autoline_matching: Optional[bool] = None)
    func NewGcpMetricsSource(ctx *Context, name string, args GcpMetricsSourceArgs, opts ...ResourceOption) (*GcpMetricsSource, error)
    public GcpMetricsSource(string name, GcpMetricsSourceArgs args, CustomResourceOptions? opts = null)
    public GcpMetricsSource(String name, GcpMetricsSourceArgs args)
public GcpMetricsSource(String name, GcpMetricsSourceArgs args, CustomResourceOptions options)

    type: sumologic:GcpMetricsSource
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 GcpMetricsSourceArgs
    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 GcpMetricsSourceArgs
    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 GcpMetricsSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GcpMetricsSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GcpMetricsSourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var gcpMetricsSourceResource = new SumoLogic.GcpMetricsSource("gcpMetricsSourceResource", new()
{
    ContentType = "string",
    Path = new SumoLogic.Inputs.GcpMetricsSourcePathArgs
    {
        Type = "string",
        LimitToServices = new[]
        {
            "string",
        },
        CustomServices = new[]
        {
            new SumoLogic.Inputs.GcpMetricsSourcePathCustomServiceArgs
            {
                Prefixes = new[]
                {
                    "string",
                },
                ServiceName = "string",
            },
        },
        EventHubName = "string",
        LimitToNamespaces = new[]
        {
            "string",
        },
        LimitToRegions = new[]
        {
            "string",
        },
        BucketName = "string",
        Namespace = "string",
        PathExpression = "string",
        Region = "string",
        SnsTopicOrSubscriptionArns = new[]
        {
            new SumoLogic.Inputs.GcpMetricsSourcePathSnsTopicOrSubscriptionArnArgs
            {
                Arn = "string",
                IsSuccess = false,
            },
        },
        TagFilters = new[]
        {
            new SumoLogic.Inputs.GcpMetricsSourcePathTagFilterArgs
            {
                Namespace = "string",
                Tags = new[]
                {
                    "string",
                },
                Type = "string",
            },
        },
        ConsumerGroup = "string",
        UseVersionedApi = false,
    },
    Authentication = new SumoLogic.Inputs.GcpMetricsSourceAuthenticationArgs
    {
        Type = "string",
        ProjectId = "string",
        Region = "string",
        ClientEmail = "string",
        ClientId = "string",
        ClientX509CertUrl = "string",
        PrivateKey = "string",
        AuthUri = "string",
        AccessKey = "string",
        PrivateKeyId = "string",
        RoleArn = "string",
        SecretKey = "string",
        SharedAccessPolicyKey = "string",
        SharedAccessPolicyName = "string",
        TokenUri = "string",
        AuthProviderX509CertUrl = "string",
    },
    CollectorId = 0,
    Filters = new[]
    {
        new SumoLogic.Inputs.GcpMetricsSourceFilterArgs
        {
            FilterType = "string",
            Name = "string",
            Regexp = "string",
            Mask = "string",
        },
    },
    HostName = "string",
    CutoffTimestamp = 0,
    DefaultDateFormats = new[]
    {
        new SumoLogic.Inputs.GcpMetricsSourceDefaultDateFormatArgs
        {
            Format = "string",
            Locator = "string",
        },
    },
    Description = "string",
    Fields = 
    {
        { "string", "string" },
    },
    Category = "string",
    ForceTimezone = false,
    HashAlgorithm = "string",
    CutoffRelativeTime = "string",
    ManualPrefixRegexp = "string",
    MultilineProcessingEnabled = false,
    Name = "string",
    AutomaticDateParsing = false,
    Paused = false,
    ScanInterval = 0,
    Timezone = "string",
    UseAutolineMatching = false,
});

    example, err := sumologic.NewGcpMetricsSource(ctx, "gcpMetricsSourceResource", &sumologic.GcpMetricsSourceArgs{
	ContentType: pulumi.String("string"),
	Path: &sumologic.GcpMetricsSourcePathArgs{
		Type: pulumi.String("string"),
		LimitToServices: pulumi.StringArray{
			pulumi.String("string"),
		},
		CustomServices: sumologic.GcpMetricsSourcePathCustomServiceArray{
			&sumologic.GcpMetricsSourcePathCustomServiceArgs{
				Prefixes: pulumi.StringArray{
					pulumi.String("string"),
				},
				ServiceName: pulumi.String("string"),
			},
		},
		EventHubName: pulumi.String("string"),
		LimitToNamespaces: pulumi.StringArray{
			pulumi.String("string"),
		},
		LimitToRegions: pulumi.StringArray{
			pulumi.String("string"),
		},
		BucketName:     pulumi.String("string"),
		Namespace:      pulumi.String("string"),
		PathExpression: pulumi.String("string"),
		Region:         pulumi.String("string"),
		SnsTopicOrSubscriptionArns: sumologic.GcpMetricsSourcePathSnsTopicOrSubscriptionArnArray{
			&sumologic.GcpMetricsSourcePathSnsTopicOrSubscriptionArnArgs{
				Arn:       pulumi.String("string"),
				IsSuccess: pulumi.Bool(false),
			},
		},
		TagFilters: sumologic.GcpMetricsSourcePathTagFilterArray{
			&sumologic.GcpMetricsSourcePathTagFilterArgs{
				Namespace: pulumi.String("string"),
				Tags: pulumi.StringArray{
					pulumi.String("string"),
				},
				Type: pulumi.String("string"),
			},
		},
		ConsumerGroup:   pulumi.String("string"),
		UseVersionedApi: pulumi.Bool(false),
	},
	Authentication: &sumologic.GcpMetricsSourceAuthenticationArgs{
		Type:                    pulumi.String("string"),
		ProjectId:               pulumi.String("string"),
		Region:                  pulumi.String("string"),
		ClientEmail:             pulumi.String("string"),
		ClientId:                pulumi.String("string"),
		ClientX509CertUrl:       pulumi.String("string"),
		PrivateKey:              pulumi.String("string"),
		AuthUri:                 pulumi.String("string"),
		AccessKey:               pulumi.String("string"),
		PrivateKeyId:            pulumi.String("string"),
		RoleArn:                 pulumi.String("string"),
		SecretKey:               pulumi.String("string"),
		SharedAccessPolicyKey:   pulumi.String("string"),
		SharedAccessPolicyName:  pulumi.String("string"),
		TokenUri:                pulumi.String("string"),
		AuthProviderX509CertUrl: pulumi.String("string"),
	},
	CollectorId: pulumi.Int(0),
	Filters: sumologic.GcpMetricsSourceFilterArray{
		&sumologic.GcpMetricsSourceFilterArgs{
			FilterType: pulumi.String("string"),
			Name:       pulumi.String("string"),
			Regexp:     pulumi.String("string"),
			Mask:       pulumi.String("string"),
		},
	},
	HostName:        pulumi.String("string"),
	CutoffTimestamp: pulumi.Int(0),
	DefaultDateFormats: sumologic.GcpMetricsSourceDefaultDateFormatArray{
		&sumologic.GcpMetricsSourceDefaultDateFormatArgs{
			Format:  pulumi.String("string"),
			Locator: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Fields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Category:                   pulumi.String("string"),
	ForceTimezone:              pulumi.Bool(false),
	HashAlgorithm:              pulumi.String("string"),
	CutoffRelativeTime:         pulumi.String("string"),
	ManualPrefixRegexp:         pulumi.String("string"),
	MultilineProcessingEnabled: pulumi.Bool(false),
	Name:                       pulumi.String("string"),
	AutomaticDateParsing:       pulumi.Bool(false),
	Paused:                     pulumi.Bool(false),
	ScanInterval:               pulumi.Int(0),
	Timezone:                   pulumi.String("string"),
	UseAutolineMatching:        pulumi.Bool(false),
})

    var gcpMetricsSourceResource = new GcpMetricsSource("gcpMetricsSourceResource", GcpMetricsSourceArgs.builder()
    .contentType("string")
    .path(GcpMetricsSourcePathArgs.builder()
        .type("string")
        .limitToServices("string")
        .customServices(GcpMetricsSourcePathCustomServiceArgs.builder()
            .prefixes("string")
            .serviceName("string")
            .build())
        .eventHubName("string")
        .limitToNamespaces("string")
        .limitToRegions("string")
        .bucketName("string")
        .namespace("string")
        .pathExpression("string")
        .region("string")
        .snsTopicOrSubscriptionArns(GcpMetricsSourcePathSnsTopicOrSubscriptionArnArgs.builder()
            .arn("string")
            .isSuccess(false)
            .build())
        .tagFilters(GcpMetricsSourcePathTagFilterArgs.builder()
            .namespace("string")
            .tags("string")
            .type("string")
            .build())
        .consumerGroup("string")
        .useVersionedApi(false)
        .build())
    .authentication(GcpMetricsSourceAuthenticationArgs.builder()
        .type("string")
        .projectId("string")
        .region("string")
        .clientEmail("string")
        .clientId("string")
        .clientX509CertUrl("string")
        .privateKey("string")
        .authUri("string")
        .accessKey("string")
        .privateKeyId("string")
        .roleArn("string")
        .secretKey("string")
        .sharedAccessPolicyKey("string")
        .sharedAccessPolicyName("string")
        .tokenUri("string")
        .authProviderX509CertUrl("string")
        .build())
    .collectorId(0)
    .filters(GcpMetricsSourceFilterArgs.builder()
        .filterType("string")
        .name("string")
        .regexp("string")
        .mask("string")
        .build())
    .hostName("string")
    .cutoffTimestamp(0)
    .defaultDateFormats(GcpMetricsSourceDefaultDateFormatArgs.builder()
        .format("string")
        .locator("string")
        .build())
    .description("string")
    .fields(Map.of("string", "string"))
    .category("string")
    .forceTimezone(false)
    .hashAlgorithm("string")
    .cutoffRelativeTime("string")
    .manualPrefixRegexp("string")
    .multilineProcessingEnabled(false)
    .name("string")
    .automaticDateParsing(false)
    .paused(false)
    .scanInterval(0)
    .timezone("string")
    .useAutolineMatching(false)
    .build());

    gcp_metrics_source_resource = sumologic.GcpMetricsSource("gcpMetricsSourceResource",
    content_type="string",
    path={
        "type": "string",
        "limit_to_services": ["string"],
        "custom_services": [{
            "prefixes": ["string"],
            "service_name": "string",
        }],
        "event_hub_name": "string",
        "limit_to_namespaces": ["string"],
        "limit_to_regions": ["string"],
        "bucket_name": "string",
        "namespace": "string",
        "path_expression": "string",
        "region": "string",
        "sns_topic_or_subscription_arns": [{
            "arn": "string",
            "is_success": False,
        }],
        "tag_filters": [{
            "namespace": "string",
            "tags": ["string"],
            "type": "string",
        }],
        "consumer_group": "string",
        "use_versioned_api": False,
    },
    authentication={
        "type": "string",
        "project_id": "string",
        "region": "string",
        "client_email": "string",
        "client_id": "string",
        "client_x509_cert_url": "string",
        "private_key": "string",
        "auth_uri": "string",
        "access_key": "string",
        "private_key_id": "string",
        "role_arn": "string",
        "secret_key": "string",
        "shared_access_policy_key": "string",
        "shared_access_policy_name": "string",
        "token_uri": "string",
        "auth_provider_x509_cert_url": "string",
    },
    collector_id=0,
    filters=[{
        "filter_type": "string",
        "name": "string",
        "regexp": "string",
        "mask": "string",
    }],
    host_name="string",
    cutoff_timestamp=0,
    default_date_formats=[{
        "format": "string",
        "locator": "string",
    }],
    description="string",
    fields={
        "string": "string",
    },
    category="string",
    force_timezone=False,
    hash_algorithm="string",
    cutoff_relative_time="string",
    manual_prefix_regexp="string",
    multiline_processing_enabled=False,
    name="string",
    automatic_date_parsing=False,
    paused=False,
    scan_interval=0,
    timezone="string",
    use_autoline_matching=False)

    const gcpMetricsSourceResource = new sumologic.GcpMetricsSource("gcpMetricsSourceResource", {
    contentType: "string",
    path: {
        type: "string",
        limitToServices: ["string"],
        customServices: [{
            prefixes: ["string"],
            serviceName: "string",
        }],
        eventHubName: "string",
        limitToNamespaces: ["string"],
        limitToRegions: ["string"],
        bucketName: "string",
        namespace: "string",
        pathExpression: "string",
        region: "string",
        snsTopicOrSubscriptionArns: [{
            arn: "string",
            isSuccess: false,
        }],
        tagFilters: [{
            namespace: "string",
            tags: ["string"],
            type: "string",
        }],
        consumerGroup: "string",
        useVersionedApi: false,
    },
    authentication: {
        type: "string",
        projectId: "string",
        region: "string",
        clientEmail: "string",
        clientId: "string",
        clientX509CertUrl: "string",
        privateKey: "string",
        authUri: "string",
        accessKey: "string",
        privateKeyId: "string",
        roleArn: "string",
        secretKey: "string",
        sharedAccessPolicyKey: "string",
        sharedAccessPolicyName: "string",
        tokenUri: "string",
        authProviderX509CertUrl: "string",
    },
    collectorId: 0,
    filters: [{
        filterType: "string",
        name: "string",
        regexp: "string",
        mask: "string",
    }],
    hostName: "string",
    cutoffTimestamp: 0,
    defaultDateFormats: [{
        format: "string",
        locator: "string",
    }],
    description: "string",
    fields: {
        string: "string",
    },
    category: "string",
    forceTimezone: false,
    hashAlgorithm: "string",
    cutoffRelativeTime: "string",
    manualPrefixRegexp: "string",
    multilineProcessingEnabled: false,
    name: "string",
    automaticDateParsing: false,
    paused: false,
    scanInterval: 0,
    timezone: "string",
    useAutolineMatching: false,
});

    type: sumologic:GcpMetricsSource
properties:
    authentication:
        accessKey: string
        authProviderX509CertUrl: string
        authUri: string
        clientEmail: string
        clientId: string
        clientX509CertUrl: string
        privateKey: string
        privateKeyId: string
        projectId: string
        region: string
        roleArn: string
        secretKey: string
        sharedAccessPolicyKey: string
        sharedAccessPolicyName: string
        tokenUri: string
        type: string
    automaticDateParsing: false
    category: string
    collectorId: 0
    contentType: string
    cutoffRelativeTime: string
    cutoffTimestamp: 0
    defaultDateFormats:
        - format: string
          locator: string
    description: string
    fields:
        string: string
    filters:
        - filterType: string
          mask: string
          name: string
          regexp: string
    forceTimezone: false
    hashAlgorithm: string
    hostName: string
    manualPrefixRegexp: string
    multilineProcessingEnabled: false
    name: string
    path:
        bucketName: string
        consumerGroup: string
        customServices:
            - prefixes:
                - string
              serviceName: string
        eventHubName: string
        limitToNamespaces:
            - string
        limitToRegions:
            - string
        limitToServices:
            - string
        namespace: string
        pathExpression: string
        region: string
        snsTopicOrSubscriptionArns:
            - arn: string
              isSuccess: false
        tagFilters:
            - namespace: string
              tags:
                - string
              type: string
        type: string
        useVersionedApi: false
    paused: false
    scanInterval: 0
    timezone: string
    useAutolineMatching: false

    GcpMetricsSource Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GcpMetricsSource resource accepts the following input properties:

    Authentication Pulumi.SumoLogic.Inputs.GcpMetricsSourceAuthentication
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    CollectorId int
    ContentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    Path Pulumi.SumoLogic.Inputs.GcpMetricsSourcePath
    Details about what data to ingest
    AutomaticDateParsing bool
    Category string
    CutoffRelativeTime string
    CutoffTimestamp int
    DefaultDateFormats List<Pulumi.SumoLogic.Inputs.GcpMetricsSourceDefaultDateFormat>
    Description string
    Fields Dictionary<string, string>
    Filters List<Pulumi.SumoLogic.Inputs.GcpMetricsSourceFilter>
    ForceTimezone bool
    HashAlgorithm string
    HostName string
    ManualPrefixRegexp string
    MultilineProcessingEnabled bool
    Name string
    Paused bool
    When set to true, the scanner is paused. To disable, set to false.
    ScanInterval int
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    Timezone string
    UseAutolineMatching bool
    Authentication GcpMetricsSourceAuthenticationArgs
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    CollectorId int
    ContentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    Path GcpMetricsSourcePathArgs
    Details about what data to ingest
    AutomaticDateParsing bool
    Category string
    CutoffRelativeTime string
    CutoffTimestamp int
    DefaultDateFormats []GcpMetricsSourceDefaultDateFormatArgs
    Description string
    Fields map[string]string
    Filters []GcpMetricsSourceFilterArgs
    ForceTimezone bool
    HashAlgorithm string
    HostName string
    ManualPrefixRegexp string
    MultilineProcessingEnabled bool
    Name string
    Paused bool
    When set to true, the scanner is paused. To disable, set to false.
    ScanInterval int
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    Timezone string
    UseAutolineMatching bool
    authentication GcpMetricsSourceAuthentication
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    collectorId Integer
    contentType String
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    path GcpMetricsSourcePath
    Details about what data to ingest
    automaticDateParsing Boolean
    category String
    cutoffRelativeTime String
    cutoffTimestamp Integer
    defaultDateFormats List<GcpMetricsSourceDefaultDateFormat>
    description String
    fields Map<String,String>
    filters List<GcpMetricsSourceFilter>
    forceTimezone Boolean
    hashAlgorithm String
    hostName String
    manualPrefixRegexp String
    multilineProcessingEnabled Boolean
    name String
    paused Boolean
    When set to true, the scanner is paused. To disable, set to false.
    scanInterval Integer
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    timezone String
    useAutolineMatching Boolean
    authentication GcpMetricsSourceAuthentication
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    collectorId number
    contentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    path GcpMetricsSourcePath
    Details about what data to ingest
    automaticDateParsing boolean
    category string
    cutoffRelativeTime string
    cutoffTimestamp number
    defaultDateFormats GcpMetricsSourceDefaultDateFormat[]
    description string
    fields {[key: string]: string}
    filters GcpMetricsSourceFilter[]
    forceTimezone boolean
    hashAlgorithm string
    hostName string
    manualPrefixRegexp string
    multilineProcessingEnabled boolean
    name string
    paused boolean
    When set to true, the scanner is paused. To disable, set to false.
    scanInterval number
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    timezone string
    useAutolineMatching boolean
    authentication GcpMetricsSourceAuthenticationArgs
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    collector_id int
    content_type str
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    path GcpMetricsSourcePathArgs
    Details about what data to ingest
    automatic_date_parsing bool
    category str
    cutoff_relative_time str
    cutoff_timestamp int
    default_date_formats Sequence[GcpMetricsSourceDefaultDateFormatArgs]
    description str
    fields Mapping[str, str]
    filters Sequence[GcpMetricsSourceFilterArgs]
    force_timezone bool
    hash_algorithm str
    host_name str
    manual_prefix_regexp str
    multiline_processing_enabled bool
    name str
    paused bool
    When set to true, the scanner is paused. To disable, set to false.
    scan_interval int
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    timezone str
    use_autoline_matching bool
    authentication Property Map
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    collectorId Number
    contentType String
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    path Property Map
    Details about what data to ingest
    automaticDateParsing Boolean
    category String
    cutoffRelativeTime String
    cutoffTimestamp Number
    defaultDateFormats List<Property Map>
    description String
    fields Map<String>
    filters List<Property Map>
    forceTimezone Boolean
    hashAlgorithm String
    hostName String
    manualPrefixRegexp String
    multilineProcessingEnabled Boolean
    name String
    paused Boolean
    When set to true, the scanner is paused. To disable, set to false.
    scanInterval Number
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    timezone String
    useAutolineMatching Boolean

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    id String
    The provider-assigned unique ID for this managed resource.
    url String

    Look up Existing GcpMetricsSource Resource

    Get an existing GcpMetricsSource 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?: GcpMetricsSourceState, opts?: CustomResourceOptions): GcpMetricsSource
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[GcpMetricsSourceAuthenticationArgs] = None,
        automatic_date_parsing: Optional[bool] = None,
        category: Optional[str] = None,
        collector_id: Optional[int] = None,
        content_type: Optional[str] = None,
        cutoff_relative_time: Optional[str] = None,
        cutoff_timestamp: Optional[int] = None,
        default_date_formats: Optional[Sequence[GcpMetricsSourceDefaultDateFormatArgs]] = None,
        description: Optional[str] = None,
        fields: Optional[Mapping[str, str]] = None,
        filters: Optional[Sequence[GcpMetricsSourceFilterArgs]] = None,
        force_timezone: Optional[bool] = None,
        hash_algorithm: Optional[str] = None,
        host_name: Optional[str] = None,
        manual_prefix_regexp: Optional[str] = None,
        multiline_processing_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        path: Optional[GcpMetricsSourcePathArgs] = None,
        paused: Optional[bool] = None,
        scan_interval: Optional[int] = None,
        timezone: Optional[str] = None,
        url: Optional[str] = None,
        use_autoline_matching: Optional[bool] = None) -> GcpMetricsSource
    func GetGcpMetricsSource(ctx *Context, name string, id IDInput, state *GcpMetricsSourceState, opts ...ResourceOption) (*GcpMetricsSource, error)
    public static GcpMetricsSource Get(string name, Input<string> id, GcpMetricsSourceState? state, CustomResourceOptions? opts = null)
    public static GcpMetricsSource get(String name, Output<String> id, GcpMetricsSourceState 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:
    Authentication Pulumi.SumoLogic.Inputs.GcpMetricsSourceAuthentication
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    AutomaticDateParsing bool
    Category string
    CollectorId int
    ContentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    CutoffRelativeTime string
    CutoffTimestamp int
    DefaultDateFormats List<Pulumi.SumoLogic.Inputs.GcpMetricsSourceDefaultDateFormat>
    Description string
    Fields Dictionary<string, string>
    Filters List<Pulumi.SumoLogic.Inputs.GcpMetricsSourceFilter>
    ForceTimezone bool
    HashAlgorithm string
    HostName string
    ManualPrefixRegexp string
    MultilineProcessingEnabled bool
    Name string
    Path Pulumi.SumoLogic.Inputs.GcpMetricsSourcePath
    Details about what data to ingest
    Paused bool
    When set to true, the scanner is paused. To disable, set to false.
    ScanInterval int
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    Timezone string
    Url string
    UseAutolineMatching bool
    Authentication GcpMetricsSourceAuthenticationArgs
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    AutomaticDateParsing bool
    Category string
    CollectorId int
    ContentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    CutoffRelativeTime string
    CutoffTimestamp int
    DefaultDateFormats []GcpMetricsSourceDefaultDateFormatArgs
    Description string
    Fields map[string]string
    Filters []GcpMetricsSourceFilterArgs
    ForceTimezone bool
    HashAlgorithm string
    HostName string
    ManualPrefixRegexp string
    MultilineProcessingEnabled bool
    Name string
    Path GcpMetricsSourcePathArgs
    Details about what data to ingest
    Paused bool
    When set to true, the scanner is paused. To disable, set to false.
    ScanInterval int
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    Timezone string
    Url string
    UseAutolineMatching bool
    authentication GcpMetricsSourceAuthentication
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    automaticDateParsing Boolean
    category String
    collectorId Integer
    contentType String
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    cutoffRelativeTime String
    cutoffTimestamp Integer
    defaultDateFormats List<GcpMetricsSourceDefaultDateFormat>
    description String
    fields Map<String,String>
    filters List<GcpMetricsSourceFilter>
    forceTimezone Boolean
    hashAlgorithm String
    hostName String
    manualPrefixRegexp String
    multilineProcessingEnabled Boolean
    name String
    path GcpMetricsSourcePath
    Details about what data to ingest
    paused Boolean
    When set to true, the scanner is paused. To disable, set to false.
    scanInterval Integer
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    timezone String
    url String
    useAutolineMatching Boolean
    authentication GcpMetricsSourceAuthentication
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    automaticDateParsing boolean
    category string
    collectorId number
    contentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    cutoffRelativeTime string
    cutoffTimestamp number
    defaultDateFormats GcpMetricsSourceDefaultDateFormat[]
    description string
    fields {[key: string]: string}
    filters GcpMetricsSourceFilter[]
    forceTimezone boolean
    hashAlgorithm string
    hostName string
    manualPrefixRegexp string
    multilineProcessingEnabled boolean
    name string
    path GcpMetricsSourcePath
    Details about what data to ingest
    paused boolean
    When set to true, the scanner is paused. To disable, set to false.
    scanInterval number
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    timezone string
    url string
    useAutolineMatching boolean
    authentication GcpMetricsSourceAuthenticationArgs
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    automatic_date_parsing bool
    category str
    collector_id int
    content_type str
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    cutoff_relative_time str
    cutoff_timestamp int
    default_date_formats Sequence[GcpMetricsSourceDefaultDateFormatArgs]
    description str
    fields Mapping[str, str]
    filters Sequence[GcpMetricsSourceFilterArgs]
    force_timezone bool
    hash_algorithm str
    host_name str
    manual_prefix_regexp str
    multiline_processing_enabled bool
    name str
    path GcpMetricsSourcePathArgs
    Details about what data to ingest
    paused bool
    When set to true, the scanner is paused. To disable, set to false.
    scan_interval int
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    timezone str
    url str
    use_autoline_matching bool
    authentication Property Map
    Authentication details for connecting to the GCP Monitoring using service_account credentials.
    automaticDateParsing Boolean
    category String
    collectorId Number
    contentType String
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    cutoffRelativeTime String
    cutoffTimestamp Number
    defaultDateFormats List<Property Map>
    description String
    fields Map<String>
    filters List<Property Map>
    forceTimezone Boolean
    hashAlgorithm String
    hostName String
    manualPrefixRegexp String
    multilineProcessingEnabled Boolean
    name String
    path Property Map
    Details about what data to ingest
    paused Boolean
    When set to true, the scanner is paused. To disable, set to false.
    scanInterval Number
    Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    timezone String
    url String
    useAutolineMatching Boolean

    Supporting Types

    GcpMetricsSourceAuthentication, GcpMetricsSourceAuthenticationArgs

    Type string
    Must be service_account.
    AccessKey string
    AuthProviderX509CertUrl string
    As per the service_account.json downloaded from GCP
    AuthUri string
    As per the service_account.json downloaded from GCP
    ClientEmail string
    As per the service_account.json downloaded from GCP
    ClientId string
    As per the service_account.json downloaded from GCP
    ClientX509CertUrl string
    As per the service_account.json downloaded from GCP
    PrivateKey string
    As per the service_account.json downloaded from GCP
    PrivateKeyId string
    As per the service_account.json downloaded from GCP
    ProjectId string
    As per the service_account.json downloaded from GCP
    Region string
    RoleArn string
    SecretKey string
    SharedAccessPolicyKey string
    SharedAccessPolicyName string
    TokenUri string
    As per the service_account.json downloaded from GCP
    Type string
    Must be service_account.
    AccessKey string
    AuthProviderX509CertUrl string
    As per the service_account.json downloaded from GCP
    AuthUri string
    As per the service_account.json downloaded from GCP
    ClientEmail string
    As per the service_account.json downloaded from GCP
    ClientId string
    As per the service_account.json downloaded from GCP
    ClientX509CertUrl string
    As per the service_account.json downloaded from GCP
    PrivateKey string
    As per the service_account.json downloaded from GCP
    PrivateKeyId string
    As per the service_account.json downloaded from GCP
    ProjectId string
    As per the service_account.json downloaded from GCP
    Region string
    RoleArn string
    SecretKey string
    SharedAccessPolicyKey string
    SharedAccessPolicyName string
    TokenUri string
    As per the service_account.json downloaded from GCP
    type String
    Must be service_account.
    accessKey String
    authProviderX509CertUrl String
    As per the service_account.json downloaded from GCP
    authUri String
    As per the service_account.json downloaded from GCP
    clientEmail String
    As per the service_account.json downloaded from GCP
    clientId String
    As per the service_account.json downloaded from GCP
    clientX509CertUrl String
    As per the service_account.json downloaded from GCP
    privateKey String
    As per the service_account.json downloaded from GCP
    privateKeyId String
    As per the service_account.json downloaded from GCP
    projectId String
    As per the service_account.json downloaded from GCP
    region String
    roleArn String
    secretKey String
    sharedAccessPolicyKey String
    sharedAccessPolicyName String
    tokenUri String
    As per the service_account.json downloaded from GCP
    type string
    Must be service_account.
    accessKey string
    authProviderX509CertUrl string
    As per the service_account.json downloaded from GCP
    authUri string
    As per the service_account.json downloaded from GCP
    clientEmail string
    As per the service_account.json downloaded from GCP
    clientId string
    As per the service_account.json downloaded from GCP
    clientX509CertUrl string
    As per the service_account.json downloaded from GCP
    privateKey string
    As per the service_account.json downloaded from GCP
    privateKeyId string
    As per the service_account.json downloaded from GCP
    projectId string
    As per the service_account.json downloaded from GCP
    region string
    roleArn string
    secretKey string
    sharedAccessPolicyKey string
    sharedAccessPolicyName string
    tokenUri string
    As per the service_account.json downloaded from GCP
    type str
    Must be service_account.
    access_key str
    auth_provider_x509_cert_url str
    As per the service_account.json downloaded from GCP
    auth_uri str
    As per the service_account.json downloaded from GCP
    client_email str
    As per the service_account.json downloaded from GCP
    client_id str
    As per the service_account.json downloaded from GCP
    client_x509_cert_url str
    As per the service_account.json downloaded from GCP
    private_key str
    As per the service_account.json downloaded from GCP
    private_key_id str
    As per the service_account.json downloaded from GCP
    project_id str
    As per the service_account.json downloaded from GCP
    region str
    role_arn str
    secret_key str
    shared_access_policy_key str
    shared_access_policy_name str
    token_uri str
    As per the service_account.json downloaded from GCP
    type String
    Must be service_account.
    accessKey String
    authProviderX509CertUrl String
    As per the service_account.json downloaded from GCP
    authUri String
    As per the service_account.json downloaded from GCP
    clientEmail String
    As per the service_account.json downloaded from GCP
    clientId String
    As per the service_account.json downloaded from GCP
    clientX509CertUrl String
    As per the service_account.json downloaded from GCP
    privateKey String
    As per the service_account.json downloaded from GCP
    privateKeyId String
    As per the service_account.json downloaded from GCP
    projectId String
    As per the service_account.json downloaded from GCP
    region String
    roleArn String
    secretKey String
    sharedAccessPolicyKey String
    sharedAccessPolicyName String
    tokenUri String
    As per the service_account.json downloaded from GCP

    GcpMetricsSourceDefaultDateFormat, GcpMetricsSourceDefaultDateFormatArgs

    Format string
    Locator string
    Format string
    Locator string
    format String
    locator String
    format string
    locator string
    format String
    locator String

    GcpMetricsSourceFilter, GcpMetricsSourceFilterArgs

    FilterType string
    Name string
    Regexp string
    Mask string
    FilterType string
    Name string
    Regexp string
    Mask string
    filterType String
    name String
    regexp String
    mask String
    filterType string
    name string
    regexp string
    mask string
    filterType String
    name String
    regexp String
    mask String

    GcpMetricsSourcePath, GcpMetricsSourcePathArgs

    Type string
    Type of polling source. This has to be GcpMetricsPath.
    BucketName string
    ConsumerGroup string
    CustomServices List<Pulumi.SumoLogic.Inputs.GcpMetricsSourcePathCustomService>
    Sumoloigc provides list of services that can be used in limit_to_services for which metrics would be collected. Custom Services allow you to define your own service w.r.t. metric collection. You can provide list of metric prefixes that should be collected as part of the custom service. This provides fine-grain control w.r.t. what all metrics are ingested by sumologic.
    EventHubName string
    LimitToNamespaces List<string>
    LimitToRegions List<string>
    List of regions for which metrics would be collected (Empty to collect from all regions)
    LimitToServices List<string>
    List of services from which metrics would be collected
    Namespace string
    PathExpression string
    Region string
    SnsTopicOrSubscriptionArns List<Pulumi.SumoLogic.Inputs.GcpMetricsSourcePathSnsTopicOrSubscriptionArn>
    TagFilters List<Pulumi.SumoLogic.Inputs.GcpMetricsSourcePathTagFilter>
    UseVersionedApi bool
    Type string
    Type of polling source. This has to be GcpMetricsPath.
    BucketName string
    ConsumerGroup string
    CustomServices []GcpMetricsSourcePathCustomService
    Sumoloigc provides list of services that can be used in limit_to_services for which metrics would be collected. Custom Services allow you to define your own service w.r.t. metric collection. You can provide list of metric prefixes that should be collected as part of the custom service. This provides fine-grain control w.r.t. what all metrics are ingested by sumologic.
    EventHubName string
    LimitToNamespaces []string
    LimitToRegions []string
    List of regions for which metrics would be collected (Empty to collect from all regions)
    LimitToServices []string
    List of services from which metrics would be collected
    Namespace string
    PathExpression string
    Region string
    SnsTopicOrSubscriptionArns []GcpMetricsSourcePathSnsTopicOrSubscriptionArn
    TagFilters []GcpMetricsSourcePathTagFilter
    UseVersionedApi bool
    type String
    Type of polling source. This has to be GcpMetricsPath.
    bucketName String
    consumerGroup String
    customServices List<GcpMetricsSourcePathCustomService>
    Sumoloigc provides list of services that can be used in limit_to_services for which metrics would be collected. Custom Services allow you to define your own service w.r.t. metric collection. You can provide list of metric prefixes that should be collected as part of the custom service. This provides fine-grain control w.r.t. what all metrics are ingested by sumologic.
    eventHubName String
    limitToNamespaces List<String>
    limitToRegions List<String>
    List of regions for which metrics would be collected (Empty to collect from all regions)
    limitToServices List<String>
    List of services from which metrics would be collected
    namespace String
    pathExpression String
    region String
    snsTopicOrSubscriptionArns List<GcpMetricsSourcePathSnsTopicOrSubscriptionArn>
    tagFilters List<GcpMetricsSourcePathTagFilter>
    useVersionedApi Boolean
    type string
    Type of polling source. This has to be GcpMetricsPath.
    bucketName string
    consumerGroup string
    customServices GcpMetricsSourcePathCustomService[]
    Sumoloigc provides list of services that can be used in limit_to_services for which metrics would be collected. Custom Services allow you to define your own service w.r.t. metric collection. You can provide list of metric prefixes that should be collected as part of the custom service. This provides fine-grain control w.r.t. what all metrics are ingested by sumologic.
    eventHubName string
    limitToNamespaces string[]
    limitToRegions string[]
    List of regions for which metrics would be collected (Empty to collect from all regions)
    limitToServices string[]
    List of services from which metrics would be collected
    namespace string
    pathExpression string
    region string
    snsTopicOrSubscriptionArns GcpMetricsSourcePathSnsTopicOrSubscriptionArn[]
    tagFilters GcpMetricsSourcePathTagFilter[]
    useVersionedApi boolean
    type str
    Type of polling source. This has to be GcpMetricsPath.
    bucket_name str
    consumer_group str
    custom_services Sequence[GcpMetricsSourcePathCustomService]
    Sumoloigc provides list of services that can be used in limit_to_services for which metrics would be collected. Custom Services allow you to define your own service w.r.t. metric collection. You can provide list of metric prefixes that should be collected as part of the custom service. This provides fine-grain control w.r.t. what all metrics are ingested by sumologic.
    event_hub_name str
    limit_to_namespaces Sequence[str]
    limit_to_regions Sequence[str]
    List of regions for which metrics would be collected (Empty to collect from all regions)
    limit_to_services Sequence[str]
    List of services from which metrics would be collected
    namespace str
    path_expression str
    region str
    sns_topic_or_subscription_arns Sequence[GcpMetricsSourcePathSnsTopicOrSubscriptionArn]
    tag_filters Sequence[GcpMetricsSourcePathTagFilter]
    use_versioned_api bool
    type String
    Type of polling source. This has to be GcpMetricsPath.
    bucketName String
    consumerGroup String
    customServices List<Property Map>
    Sumoloigc provides list of services that can be used in limit_to_services for which metrics would be collected. Custom Services allow you to define your own service w.r.t. metric collection. You can provide list of metric prefixes that should be collected as part of the custom service. This provides fine-grain control w.r.t. what all metrics are ingested by sumologic.
    eventHubName String
    limitToNamespaces List<String>
    limitToRegions List<String>
    List of regions for which metrics would be collected (Empty to collect from all regions)
    limitToServices List<String>
    List of services from which metrics would be collected
    namespace String
    pathExpression String
    region String
    snsTopicOrSubscriptionArns List<Property Map>
    tagFilters List<Property Map>
    useVersionedApi Boolean

    GcpMetricsSourcePathCustomService, GcpMetricsSourcePathCustomServiceArgs

    Prefixes List<string>
    List of metric type prefixes. Eg: ["compute.googleapis.com/instance/","compute.googleapis.com/guest/"]
    ServiceName string
    Name of the custom service you want to define.
    Prefixes []string
    List of metric type prefixes. Eg: ["compute.googleapis.com/instance/","compute.googleapis.com/guest/"]
    ServiceName string
    Name of the custom service you want to define.
    prefixes List<String>
    List of metric type prefixes. Eg: ["compute.googleapis.com/instance/","compute.googleapis.com/guest/"]
    serviceName String
    Name of the custom service you want to define.
    prefixes string[]
    List of metric type prefixes. Eg: ["compute.googleapis.com/instance/","compute.googleapis.com/guest/"]
    serviceName string
    Name of the custom service you want to define.
    prefixes Sequence[str]
    List of metric type prefixes. Eg: ["compute.googleapis.com/instance/","compute.googleapis.com/guest/"]
    service_name str
    Name of the custom service you want to define.
    prefixes List<String>
    List of metric type prefixes. Eg: ["compute.googleapis.com/instance/","compute.googleapis.com/guest/"]
    serviceName String
    Name of the custom service you want to define.

    GcpMetricsSourcePathSnsTopicOrSubscriptionArn, GcpMetricsSourcePathSnsTopicOrSubscriptionArnArgs

    Arn string
    IsSuccess bool
    Arn string
    IsSuccess bool
    arn String
    isSuccess Boolean
    arn string
    isSuccess boolean
    arn str
    is_success bool
    arn String
    isSuccess Boolean

    GcpMetricsSourcePathTagFilter, GcpMetricsSourcePathTagFilterArgs

    Namespace string
    Tags List<string>
    Type string
    Namespace string
    Tags []string
    Type string
    namespace String
    tags List<String>
    type String
    namespace string
    tags string[]
    type string
    namespace str
    tags Sequence[str]
    type str
    namespace String
    tags List<String>
    type String

    Import

    GCP Metrics sources can be imported using the collector and source IDs (collector/source), e.g.:

    hcl

    $ pulumi import sumologic:index/gcpMetricsSource:GcpMetricsSource test 123/456

    GCP Metrics sources can be imported using the collector name and source name (collectorName/sourceName), e.g.:

    hcl

    $ pulumi import sumologic:index/gcpMetricsSource:GcpMetricsSource test my-test-collector/my-test-source

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Sumo Logic pulumi/pulumi-sumologic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
    pulumi/pulumi-sumologic