Docs Home
Sumo Logic v1.0.7 published on Friday, Apr 11, 2025 by Pulumi
sumologic.GcpMetricsSource
Explore with Pulumi AI
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",
},
Region = "string",
CustomServices = new[]
{
new SumoLogic.Inputs.GcpMetricsSourcePathCustomServiceArgs
{
Prefixes = new[]
{
"string",
},
ServiceName = "string",
},
},
Environment = "string",
EventHubName = "string",
LimitToNamespaces = new[]
{
"string",
},
ConsumerGroup = "string",
Namespace = "string",
LimitToRegions = new[]
{
"string",
},
PathExpression = "string",
AzureTagFilters = new[]
{
new SumoLogic.Inputs.GcpMetricsSourcePathAzureTagFilterArgs
{
Type = "string",
Namespace = "string",
Tags = new[]
{
new SumoLogic.Inputs.GcpMetricsSourcePathAzureTagFilterTagArgs
{
Name = "string",
Values = new[]
{
"string",
},
},
},
},
},
SnsTopicOrSubscriptionArns = new[]
{
new SumoLogic.Inputs.GcpMetricsSourcePathSnsTopicOrSubscriptionArnArgs
{
Arn = "string",
IsSuccess = false,
},
},
TagFilters = new[]
{
new SumoLogic.Inputs.GcpMetricsSourcePathTagFilterArgs
{
Namespace = "string",
Tags = new[]
{
"string",
},
Type = "string",
},
},
BucketName = "string",
UseVersionedApi = false,
},
Authentication = new SumoLogic.Inputs.GcpMetricsSourceAuthenticationArgs
{
Type = "string",
PrivateKeyId = "string",
Region = "string",
ClientEmail = "string",
ClientId = "string",
ClientSecret = "string",
ClientX509CertUrl = "string",
PrivateKey = "string",
AccessKey = "string",
AuthUri = "string",
RoleArn = "string",
ProjectId = "string",
SecretKey = "string",
SharedAccessPolicyKey = "string",
SharedAccessPolicyName = "string",
TenantId = "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"),
},
Region: pulumi.String("string"),
CustomServices: sumologic.GcpMetricsSourcePathCustomServiceArray{
&sumologic.GcpMetricsSourcePathCustomServiceArgs{
Prefixes: pulumi.StringArray{
pulumi.String("string"),
},
ServiceName: pulumi.String("string"),
},
},
Environment: pulumi.String("string"),
EventHubName: pulumi.String("string"),
LimitToNamespaces: pulumi.StringArray{
pulumi.String("string"),
},
ConsumerGroup: pulumi.String("string"),
Namespace: pulumi.String("string"),
LimitToRegions: pulumi.StringArray{
pulumi.String("string"),
},
PathExpression: pulumi.String("string"),
AzureTagFilters: sumologic.GcpMetricsSourcePathAzureTagFilterArray{
&sumologic.GcpMetricsSourcePathAzureTagFilterArgs{
Type: pulumi.String("string"),
Namespace: pulumi.String("string"),
Tags: sumologic.GcpMetricsSourcePathAzureTagFilterTagArray{
&sumologic.GcpMetricsSourcePathAzureTagFilterTagArgs{
Name: pulumi.String("string"),
Values: pulumi.StringArray{
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"),
},
},
BucketName: pulumi.String("string"),
UseVersionedApi: pulumi.Bool(false),
},
Authentication: &sumologic.GcpMetricsSourceAuthenticationArgs{
Type: pulumi.String("string"),
PrivateKeyId: pulumi.String("string"),
Region: pulumi.String("string"),
ClientEmail: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientX509CertUrl: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
AccessKey: pulumi.String("string"),
AuthUri: pulumi.String("string"),
RoleArn: pulumi.String("string"),
ProjectId: pulumi.String("string"),
SecretKey: pulumi.String("string"),
SharedAccessPolicyKey: pulumi.String("string"),
SharedAccessPolicyName: pulumi.String("string"),
TenantId: 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")
.region("string")
.customServices(GcpMetricsSourcePathCustomServiceArgs.builder()
.prefixes("string")
.serviceName("string")
.build())
.environment("string")
.eventHubName("string")
.limitToNamespaces("string")
.consumerGroup("string")
.namespace("string")
.limitToRegions("string")
.pathExpression("string")
.azureTagFilters(GcpMetricsSourcePathAzureTagFilterArgs.builder()
.type("string")
.namespace("string")
.tags(GcpMetricsSourcePathAzureTagFilterTagArgs.builder()
.name("string")
.values("string")
.build())
.build())
.snsTopicOrSubscriptionArns(GcpMetricsSourcePathSnsTopicOrSubscriptionArnArgs.builder()
.arn("string")
.isSuccess(false)
.build())
.tagFilters(GcpMetricsSourcePathTagFilterArgs.builder()
.namespace("string")
.tags("string")
.type("string")
.build())
.bucketName("string")
.useVersionedApi(false)
.build())
.authentication(GcpMetricsSourceAuthenticationArgs.builder()
.type("string")
.privateKeyId("string")
.region("string")
.clientEmail("string")
.clientId("string")
.clientSecret("string")
.clientX509CertUrl("string")
.privateKey("string")
.accessKey("string")
.authUri("string")
.roleArn("string")
.projectId("string")
.secretKey("string")
.sharedAccessPolicyKey("string")
.sharedAccessPolicyName("string")
.tenantId("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"],
"region": "string",
"custom_services": [{
"prefixes": ["string"],
"service_name": "string",
}],
"environment": "string",
"event_hub_name": "string",
"limit_to_namespaces": ["string"],
"consumer_group": "string",
"namespace": "string",
"limit_to_regions": ["string"],
"path_expression": "string",
"azure_tag_filters": [{
"type": "string",
"namespace": "string",
"tags": [{
"name": "string",
"values": ["string"],
}],
}],
"sns_topic_or_subscription_arns": [{
"arn": "string",
"is_success": False,
}],
"tag_filters": [{
"namespace": "string",
"tags": ["string"],
"type": "string",
}],
"bucket_name": "string",
"use_versioned_api": False,
},
authentication={
"type": "string",
"private_key_id": "string",
"region": "string",
"client_email": "string",
"client_id": "string",
"client_secret": "string",
"client_x509_cert_url": "string",
"private_key": "string",
"access_key": "string",
"auth_uri": "string",
"role_arn": "string",
"project_id": "string",
"secret_key": "string",
"shared_access_policy_key": "string",
"shared_access_policy_name": "string",
"tenant_id": "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"],
region: "string",
customServices: [{
prefixes: ["string"],
serviceName: "string",
}],
environment: "string",
eventHubName: "string",
limitToNamespaces: ["string"],
consumerGroup: "string",
namespace: "string",
limitToRegions: ["string"],
pathExpression: "string",
azureTagFilters: [{
type: "string",
namespace: "string",
tags: [{
name: "string",
values: ["string"],
}],
}],
snsTopicOrSubscriptionArns: [{
arn: "string",
isSuccess: false,
}],
tagFilters: [{
namespace: "string",
tags: ["string"],
type: "string",
}],
bucketName: "string",
useVersionedApi: false,
},
authentication: {
type: "string",
privateKeyId: "string",
region: "string",
clientEmail: "string",
clientId: "string",
clientSecret: "string",
clientX509CertUrl: "string",
privateKey: "string",
accessKey: "string",
authUri: "string",
roleArn: "string",
projectId: "string",
secretKey: "string",
sharedAccessPolicyKey: "string",
sharedAccessPolicyName: "string",
tenantId: "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
clientSecret: string
clientX509CertUrl: string
privateKey: string
privateKeyId: string
projectId: string
region: string
roleArn: string
secretKey: string
sharedAccessPolicyKey: string
sharedAccessPolicyName: string
tenantId: 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:
azureTagFilters:
- namespace: string
tags:
- name: string
values:
- string
type: string
bucketName: string
consumerGroup: string
customServices:
- prefixes:
- string
serviceName: string
environment: 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.
Sumo Logic. Inputs. Gcp Metrics Source Authentication - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- Collector
Id int - Content
Type string - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- Path
Pulumi.
Sumo Logic. Inputs. Gcp Metrics Source Path - Details about what data to ingest
- Automatic
Date boolParsing - Category string
- Cutoff
Relative stringTime - Cutoff
Timestamp int - Default
Date List<Pulumi.Formats Sumo Logic. Inputs. Gcp Metrics Source Default Date Format> - Description string
- Fields Dictionary<string, string>
- Filters
List<Pulumi.
Sumo Logic. Inputs. Gcp Metrics Source Filter> - Force
Timezone bool - Hash
Algorithm string - Host
Name string - Manual
Prefix stringRegexp - Multiline
Processing boolEnabled - Name string
- 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 string
- Use
Autoline boolMatching
- Authentication
Gcp
Metrics Source Authentication Args - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- Collector
Id int - Content
Type string - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- Path
Gcp
Metrics Source Path Args - Details about what data to ingest
- Automatic
Date boolParsing - Category string
- Cutoff
Relative stringTime - Cutoff
Timestamp int - Default
Date []GcpFormats Metrics Source Default Date Format Args - Description string
- Fields map[string]string
- Filters
[]Gcp
Metrics Source Filter Args - Force
Timezone bool - Hash
Algorithm string - Host
Name string - Manual
Prefix stringRegexp - Multiline
Processing boolEnabled - Name string
- 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 string
- Use
Autoline boolMatching
- authentication
Gcp
Metrics Source Authentication - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- collector
Id Integer - content
Type String - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- path
Gcp
Metrics Source Path - Details about what data to ingest
- automatic
Date BooleanParsing - category String
- cutoff
Relative StringTime - cutoff
Timestamp Integer - default
Date List<GcpFormats Metrics Source Default Date Format> - description String
- fields Map<String,String>
- filters
List<Gcp
Metrics Source Filter> - force
Timezone Boolean - hash
Algorithm String - host
Name String - manual
Prefix StringRegexp - multiline
Processing BooleanEnabled - name String
- paused Boolean
- When set to true, the scanner is paused. To disable, set to false.
- scan
Interval Integer - Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
- timezone String
- use
Autoline BooleanMatching
- authentication
Gcp
Metrics Source Authentication - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- collector
Id number - content
Type string - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- path
Gcp
Metrics Source Path - Details about what data to ingest
- automatic
Date booleanParsing - category string
- cutoff
Relative stringTime - cutoff
Timestamp number - default
Date GcpFormats Metrics Source Default Date Format[] - description string
- fields {[key: string]: string}
- filters
Gcp
Metrics Source Filter[] - force
Timezone boolean - hash
Algorithm string - host
Name string - manual
Prefix stringRegexp - multiline
Processing booleanEnabled - name string
- paused boolean
- When set to true, the scanner is paused. To disable, set to false.
- scan
Interval number - Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
- timezone string
- use
Autoline booleanMatching
- authentication
Gcp
Metrics Source Authentication Args - 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
Gcp
Metrics Source Path Args - Details about what data to ingest
- automatic_
date_ boolparsing - category str
- cutoff_
relative_ strtime - cutoff_
timestamp int - default_
date_ Sequence[Gcpformats Metrics Source Default Date Format Args] - description str
- fields Mapping[str, str]
- filters
Sequence[Gcp
Metrics Source Filter Args] - force_
timezone bool - hash_
algorithm str - host_
name str - manual_
prefix_ strregexp - multiline_
processing_ boolenabled - 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_ boolmatching
- authentication Property Map
- Authentication details for connecting to the GCP Monitoring using service_account credentials.
- collector
Id Number - content
Type 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
- automatic
Date BooleanParsing - category String
- cutoff
Relative StringTime - cutoff
Timestamp Number - default
Date List<Property Map>Formats - description String
- fields Map<String>
- filters List<Property Map>
- force
Timezone Boolean - hash
Algorithm String - host
Name String - manual
Prefix StringRegexp - multiline
Processing BooleanEnabled - name String
- paused Boolean
- When set to true, the scanner is paused. To disable, set to false.
- scan
Interval Number - Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
- timezone String
- use
Autoline BooleanMatching
Outputs
All input properties are implicitly available as output properties. Additionally, the GcpMetricsSource resource produces the following output properties:
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) -> GcpMetricsSourcefunc 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)resources: _: type: sumologic:GcpMetricsSource get: id: ${id}- 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.
- Authentication
Pulumi.
Sumo Logic. Inputs. Gcp Metrics Source Authentication - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- Automatic
Date boolParsing - Category string
- Collector
Id int - Content
Type string - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- Cutoff
Relative stringTime - Cutoff
Timestamp int - Default
Date List<Pulumi.Formats Sumo Logic. Inputs. Gcp Metrics Source Default Date Format> - Description string
- Fields Dictionary<string, string>
- Filters
List<Pulumi.
Sumo Logic. Inputs. Gcp Metrics Source Filter> - Force
Timezone bool - Hash
Algorithm string - Host
Name string - Manual
Prefix stringRegexp - Multiline
Processing boolEnabled - Name string
- Path
Pulumi.
Sumo Logic. Inputs. Gcp Metrics Source Path - 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 string
- Url string
- Use
Autoline boolMatching
- Authentication
Gcp
Metrics Source Authentication Args - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- Automatic
Date boolParsing - Category string
- Collector
Id int - Content
Type string - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- Cutoff
Relative stringTime - Cutoff
Timestamp int - Default
Date []GcpFormats Metrics Source Default Date Format Args - Description string
- Fields map[string]string
- Filters
[]Gcp
Metrics Source Filter Args - Force
Timezone bool - Hash
Algorithm string - Host
Name string - Manual
Prefix stringRegexp - Multiline
Processing boolEnabled - Name string
- Path
Gcp
Metrics Source Path Args - 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 string
- Url string
- Use
Autoline boolMatching
- authentication
Gcp
Metrics Source Authentication - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- automatic
Date BooleanParsing - category String
- collector
Id Integer - content
Type String - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- cutoff
Relative StringTime - cutoff
Timestamp Integer - default
Date List<GcpFormats Metrics Source Default Date Format> - description String
- fields Map<String,String>
- filters
List<Gcp
Metrics Source Filter> - force
Timezone Boolean - hash
Algorithm String - host
Name String - manual
Prefix StringRegexp - multiline
Processing BooleanEnabled - name String
- path
Gcp
Metrics Source Path - Details about what data to ingest
- paused Boolean
- When set to true, the scanner is paused. To disable, set to false.
- scan
Interval 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
- use
Autoline BooleanMatching
- authentication
Gcp
Metrics Source Authentication - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- automatic
Date booleanParsing - category string
- collector
Id number - content
Type string - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- cutoff
Relative stringTime - cutoff
Timestamp number - default
Date GcpFormats Metrics Source Default Date Format[] - description string
- fields {[key: string]: string}
- filters
Gcp
Metrics Source Filter[] - force
Timezone boolean - hash
Algorithm string - host
Name string - manual
Prefix stringRegexp - multiline
Processing booleanEnabled - name string
- path
Gcp
Metrics Source Path - Details about what data to ingest
- paused boolean
- When set to true, the scanner is paused. To disable, set to false.
- scan
Interval 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
- use
Autoline booleanMatching
- authentication
Gcp
Metrics Source Authentication Args - Authentication details for connecting to the GCP Monitoring using service_account credentials.
- automatic_
date_ boolparsing - 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_ strtime - cutoff_
timestamp int - default_
date_ Sequence[Gcpformats Metrics Source Default Date Format Args] - description str
- fields Mapping[str, str]
- filters
Sequence[Gcp
Metrics Source Filter Args] - force_
timezone bool - hash_
algorithm str - host_
name str - manual_
prefix_ strregexp - multiline_
processing_ boolenabled - name str
- path
Gcp
Metrics Source Path Args - 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_ boolmatching
- authentication Property Map
- Authentication details for connecting to the GCP Monitoring using service_account credentials.
- automatic
Date BooleanParsing - category String
- collector
Id Number - content
Type String - The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
- cutoff
Relative StringTime - cutoff
Timestamp Number - default
Date List<Property Map>Formats - description String
- fields Map<String>
- filters List<Property Map>
- force
Timezone Boolean - hash
Algorithm String - host
Name String - manual
Prefix StringRegexp - multiline
Processing BooleanEnabled - 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.
- scan
Interval 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
- use
Autoline BooleanMatching
Supporting Types
GcpMetricsSourceAuthentication, GcpMetricsSourceAuthenticationArgs
- Type string
- Must be
service_account. - Access
Key string - Auth
Provider stringX509Cert Url - As per the service_account.json downloaded from GCP
- Auth
Uri string - As per the service_account.json downloaded from GCP
- Client
Email string - As per the service_account.json downloaded from GCP
- Client
Id string - As per the service_account.json downloaded from GCP
- Client
Secret string - Client
X509Cert stringUrl - As per the service_account.json downloaded from GCP
- Private
Key string - As per the service_account.json downloaded from GCP
- Private
Key stringId - As per the service_account.json downloaded from GCP
- Project
Id string - As per the service_account.json downloaded from GCP
- Region string
- Role
Arn string - Secret
Key string - string
- string
- Tenant
Id string - Token
Uri string - As per the service_account.json downloaded from GCP
- Type string
- Must be
service_account. - Access
Key string - Auth
Provider stringX509Cert Url - As per the service_account.json downloaded from GCP
- Auth
Uri string - As per the service_account.json downloaded from GCP
- Client
Email string - As per the service_account.json downloaded from GCP
- Client
Id string - As per the service_account.json downloaded from GCP
- Client
Secret string - Client
X509Cert stringUrl - As per the service_account.json downloaded from GCP
- Private
Key string - As per the service_account.json downloaded from GCP
- Private
Key stringId - As per the service_account.json downloaded from GCP
- Project
Id string - As per the service_account.json downloaded from GCP
- Region string
- Role
Arn string - Secret
Key string - string
- string
- Tenant
Id string - Token
Uri string - As per the service_account.json downloaded from GCP
- type String
- Must be
service_account. - access
Key String - auth
Provider StringX509Cert Url - As per the service_account.json downloaded from GCP
- auth
Uri String - As per the service_account.json downloaded from GCP
- client
Email String - As per the service_account.json downloaded from GCP
- client
Id String - As per the service_account.json downloaded from GCP
- client
Secret String - client
X509Cert StringUrl - As per the service_account.json downloaded from GCP
- private
Key String - As per the service_account.json downloaded from GCP
- private
Key StringId - As per the service_account.json downloaded from GCP
- project
Id String - As per the service_account.json downloaded from GCP
- region String
- role
Arn String - secret
Key String - String
- String
- tenant
Id String - token
Uri String - As per the service_account.json downloaded from GCP
- type string
- Must be
service_account. - access
Key string - auth
Provider stringX509Cert Url - As per the service_account.json downloaded from GCP
- auth
Uri string - As per the service_account.json downloaded from GCP
- client
Email string - As per the service_account.json downloaded from GCP
- client
Id string - As per the service_account.json downloaded from GCP
- client
Secret string - client
X509Cert stringUrl - As per the service_account.json downloaded from GCP
- private
Key string - As per the service_account.json downloaded from GCP
- private
Key stringId - As per the service_account.json downloaded from GCP
- project
Id string - As per the service_account.json downloaded from GCP
- region string
- role
Arn string - secret
Key string - string
- string
- tenant
Id string - token
Uri string - As per the service_account.json downloaded from GCP
- type str
- Must be
service_account. - access_
key str - auth_
provider_ strx509_ cert_ url - 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_
secret str - client_
x509_ strcert_ url - As per the service_account.json downloaded from GCP
- private_
key str - As per the service_account.json downloaded from GCP
- private_
key_ strid - 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 - str
- str
- tenant_
id str - token_
uri str - As per the service_account.json downloaded from GCP
- type String
- Must be
service_account. - access
Key String - auth
Provider StringX509Cert Url - As per the service_account.json downloaded from GCP
- auth
Uri String - As per the service_account.json downloaded from GCP
- client
Email String - As per the service_account.json downloaded from GCP
- client
Id String - As per the service_account.json downloaded from GCP
- client
Secret String - client
X509Cert StringUrl - As per the service_account.json downloaded from GCP
- private
Key String - As per the service_account.json downloaded from GCP
- private
Key StringId - As per the service_account.json downloaded from GCP
- project
Id String - As per the service_account.json downloaded from GCP
- region String
- role
Arn String - secret
Key String - String
- String
- tenant
Id String - token
Uri String - As per the service_account.json downloaded from GCP
GcpMetricsSourceDefaultDateFormat, GcpMetricsSourceDefaultDateFormatArgs
GcpMetricsSourceFilter, GcpMetricsSourceFilterArgs
- Filter
Type string - Name string
- Regexp string
- Mask string
- Filter
Type string - Name string
- Regexp string
- Mask string
- filter
Type String - name String
- regexp String
- mask String
- filter
Type string - name string
- regexp string
- mask string
- filter_
type str - name str
- regexp str
- mask str
- filter
Type String - name String
- regexp String
- mask String
GcpMetricsSourcePath, GcpMetricsSourcePathArgs
- Type string
- Type of polling source. This has to be
GcpMetricsPath. - Azure
Tag List<Pulumi.Filters Sumo Logic. Inputs. Gcp Metrics Source Path Azure Tag Filter> - Bucket
Name string - Consumer
Group string - Custom
Services List<Pulumi.Sumo Logic. Inputs. Gcp Metrics Source Path Custom Service> - 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.
- Environment string
- Event
Hub stringName - Limit
To List<string>Namespaces - Limit
To List<string>Regions - List of regions for which metrics would be collected (Empty to collect from all regions)
- Limit
To List<string>Services - List of services from which metrics would be collected
- Namespace string
- Path
Expression string - Region string
- Sns
Topic List<Pulumi.Or Subscription Arns Sumo Logic. Inputs. Gcp Metrics Source Path Sns Topic Or Subscription Arn> - Tag
Filters List<Pulumi.Sumo Logic. Inputs. Gcp Metrics Source Path Tag Filter> - Use
Versioned boolApi
- Type string
- Type of polling source. This has to be
GcpMetricsPath. - Azure
Tag []GcpFilters Metrics Source Path Azure Tag Filter - Bucket
Name string - Consumer
Group string - Custom
Services []GcpMetrics Source Path Custom Service - 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.
- Environment string
- Event
Hub stringName - Limit
To []stringNamespaces - Limit
To []stringRegions - List of regions for which metrics would be collected (Empty to collect from all regions)
- Limit
To []stringServices - List of services from which metrics would be collected
- Namespace string
- Path
Expression string - Region string
- Sns
Topic []GcpOr Subscription Arns Metrics Source Path Sns Topic Or Subscription Arn - Tag
Filters []GcpMetrics Source Path Tag Filter - Use
Versioned boolApi
- type String
- Type of polling source. This has to be
GcpMetricsPath. - azure
Tag List<GcpFilters Metrics Source Path Azure Tag Filter> - bucket
Name String - consumer
Group String - custom
Services List<GcpMetrics Source Path Custom Service> - 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.
- environment String
- event
Hub StringName - limit
To List<String>Namespaces - limit
To List<String>Regions - List of regions for which metrics would be collected (Empty to collect from all regions)
- limit
To List<String>Services - List of services from which metrics would be collected
- namespace String
- path
Expression String - region String
- sns
Topic List<GcpOr Subscription Arns Metrics Source Path Sns Topic Or Subscription Arn> - tag
Filters List<GcpMetrics Source Path Tag Filter> - use
Versioned BooleanApi
- type string
- Type of polling source. This has to be
GcpMetricsPath. - azure
Tag GcpFilters Metrics Source Path Azure Tag Filter[] - bucket
Name string - consumer
Group string - custom
Services GcpMetrics Source Path Custom Service[] - 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.
- environment string
- event
Hub stringName - limit
To string[]Namespaces - limit
To string[]Regions - List of regions for which metrics would be collected (Empty to collect from all regions)
- limit
To string[]Services - List of services from which metrics would be collected
- namespace string
- path
Expression string - region string
- sns
Topic GcpOr Subscription Arns Metrics Source Path Sns Topic Or Subscription Arn[] - tag
Filters GcpMetrics Source Path Tag Filter[] - use
Versioned booleanApi
- type str
- Type of polling source. This has to be
GcpMetricsPath. - azure_
tag_ Sequence[Gcpfilters Metrics Source Path Azure Tag Filter] - bucket_
name str - consumer_
group str - custom_
services Sequence[GcpMetrics Source Path Custom Service] - 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.
- environment str
- event_
hub_ strname - limit_
to_ Sequence[str]namespaces - limit_
to_ Sequence[str]regions - List of regions for which metrics would be collected (Empty to collect from all regions)
- limit_
to_ Sequence[str]services - List of services from which metrics would be collected
- namespace str
- path_
expression str - region str
- sns_
topic_ Sequence[Gcpor_ subscription_ arns Metrics Source Path Sns Topic Or Subscription Arn] - tag_
filters Sequence[GcpMetrics Source Path Tag Filter] - use_
versioned_ boolapi
- type String
- Type of polling source. This has to be
GcpMetricsPath. - azure
Tag List<Property Map>Filters - bucket
Name String - consumer
Group String - custom
Services 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.
- environment String
- event
Hub StringName - limit
To List<String>Namespaces - limit
To List<String>Regions - List of regions for which metrics would be collected (Empty to collect from all regions)
- limit
To List<String>Services - List of services from which metrics would be collected
- namespace String
- path
Expression String - region String
- sns
Topic List<Property Map>Or Subscription Arns - tag
Filters List<Property Map> - use
Versioned BooleanApi
GcpMetricsSourcePathAzureTagFilter, GcpMetricsSourcePathAzureTagFilterArgs
- Type string
- Namespace string
-
[]Gcp
Metrics Source Path Azure Tag Filter Tag
- type String
- namespace String
-
List<Gcp
Metrics Source Path Azure Tag Filter Tag>
- type string
- namespace string
-
Gcp
Metrics Source Path Azure Tag Filter Tag[]
- type String
- namespace String
- List<Property Map>
GcpMetricsSourcePathAzureTagFilterTag, GcpMetricsSourcePathAzureTagFilterTagArgs
GcpMetricsSourcePathCustomService, GcpMetricsSourcePathCustomServiceArgs
- Prefixes List<string>
- List of metric type prefixes. Eg:
["compute.googleapis.com/instance/","compute.googleapis.com/guest/"] - Service
Name 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/"] - Service
Name 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/"] - service
Name 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/"] - service
Name 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/"] - service
Name String - Name of the custom service you want to define.
GcpMetricsSourcePathSnsTopicOrSubscriptionArn, GcpMetricsSourcePathSnsTopicOrSubscriptionArnArgs
- arn str
- is_
success bool
GcpMetricsSourcePathTagFilter, GcpMetricsSourcePathTagFilterArgs
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
sumologicTerraform Provider.