sumologic logo
Sumo Logic v0.11.0, Jan 18 23

sumologic.MetadataSource

Provides a Sumologic Metadata (Tag) source. This source allows you to collect tags from EC2 instances running on AWS.

IMPORTANT: The AWS credentials are stored in plain-text in the state. This is a potential security issue.

Create MetadataSource Resource

new MetadataSource(name: string, args: MetadataSourceArgs, opts?: CustomResourceOptions);
@overload
def MetadataSource(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   authentication: Optional[MetadataSourceAuthenticationArgs] = 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[MetadataSourceDefaultDateFormatArgs]] = None,
                   description: Optional[str] = None,
                   fields: Optional[Mapping[str, str]] = None,
                   filters: Optional[Sequence[MetadataSourceFilterArgs]] = None,
                   force_timezone: Optional[bool] = None,
                   host_name: Optional[str] = None,
                   manual_prefix_regexp: Optional[str] = None,
                   multiline_processing_enabled: Optional[bool] = None,
                   name: Optional[str] = None,
                   path: Optional[MetadataSourcePathArgs] = None,
                   paused: Optional[bool] = None,
                   scan_interval: Optional[int] = None,
                   timezone: Optional[str] = None,
                   use_autoline_matching: Optional[bool] = None)
@overload
def MetadataSource(resource_name: str,
                   args: MetadataSourceArgs,
                   opts: Optional[ResourceOptions] = None)
func NewMetadataSource(ctx *Context, name string, args MetadataSourceArgs, opts ...ResourceOption) (*MetadataSource, error)
public MetadataSource(string name, MetadataSourceArgs args, CustomResourceOptions? opts = null)
public MetadataSource(String name, MetadataSourceArgs args)
public MetadataSource(String name, MetadataSourceArgs args, CustomResourceOptions options)
type: sumologic:MetadataSource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

MetadataSource Resource Properties

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

Inputs

The MetadataSource resource accepts the following input properties:

Authentication Pulumi.SumoLogic.Inputs.MetadataSourceAuthenticationArgs

Authentication details for AWS access.

CollectorId int
ContentType string

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

Path Pulumi.SumoLogic.Inputs.MetadataSourcePathArgs

The location to scan for new data.

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.

AutomaticDateParsing bool
Category string
CutoffRelativeTime string
CutoffTimestamp int
DefaultDateFormats List<Pulumi.SumoLogic.Inputs.MetadataSourceDefaultDateFormatArgs>
Description string
Fields Dictionary<string, string>
Filters List<Pulumi.SumoLogic.Inputs.MetadataSourceFilterArgs>
ForceTimezone bool
HostName string
ManualPrefixRegexp string
MultilineProcessingEnabled bool
Name string
Timezone string
UseAutolineMatching bool
Authentication MetadataSourceAuthenticationArgs

Authentication details for AWS access.

CollectorId int
ContentType string

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

Path MetadataSourcePathArgs

The location to scan for new data.

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.

AutomaticDateParsing bool
Category string
CutoffRelativeTime string
CutoffTimestamp int
DefaultDateFormats []MetadataSourceDefaultDateFormatArgs
Description string
Fields map[string]string
Filters []MetadataSourceFilterArgs
ForceTimezone bool
HostName string
ManualPrefixRegexp string
MultilineProcessingEnabled bool
Name string
Timezone string
UseAutolineMatching bool
authentication MetadataSourceAuthenticationArgs

Authentication details for AWS access.

collectorId Integer
contentType String

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

path MetadataSourcePathArgs

The location to scan for new data.

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.

automaticDateParsing Boolean
category String
cutoffRelativeTime String
cutoffTimestamp Integer
defaultDateFormats List<MetadataSourceDefaultDateFormatArgs>
description String
fields Map<String,String>
filters List<MetadataSourceFilterArgs>
forceTimezone Boolean
hostName String
manualPrefixRegexp String
multilineProcessingEnabled Boolean
name String
timezone String
useAutolineMatching Boolean
authentication MetadataSourceAuthenticationArgs

Authentication details for AWS access.

collectorId number
contentType string

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

path MetadataSourcePathArgs

The location to scan for new data.

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.

automaticDateParsing boolean
category string
cutoffRelativeTime string
cutoffTimestamp number
defaultDateFormats MetadataSourceDefaultDateFormatArgs[]
description string
fields {[key: string]: string}
filters MetadataSourceFilterArgs[]
forceTimezone boolean
hostName string
manualPrefixRegexp string
multilineProcessingEnabled boolean
name string
timezone string
useAutolineMatching boolean
authentication MetadataSourceAuthenticationArgs

Authentication details for AWS access.

collector_id int
content_type str

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

path MetadataSourcePathArgs

The location to scan for new data.

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.

automatic_date_parsing bool
category str
cutoff_relative_time str
cutoff_timestamp int
default_date_formats Sequence[MetadataSourceDefaultDateFormatArgs]
description str
fields Mapping[str, str]
filters Sequence[MetadataSourceFilterArgs]
force_timezone bool
host_name str
manual_prefix_regexp str
multiline_processing_enabled bool
name str
timezone str
use_autoline_matching bool
authentication Property Map

Authentication details for AWS access.

collectorId Number
contentType String

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

path Property Map

The location to scan for new data.

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.

automaticDateParsing Boolean
category String
cutoffRelativeTime String
cutoffTimestamp Number
defaultDateFormats List<Property Map>
description String
fields Map<String>
filters List<Property Map>
forceTimezone Boolean
hostName String
manualPrefixRegexp String
multilineProcessingEnabled Boolean
name String
timezone String
useAutolineMatching Boolean

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Url string

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

Id string

The provider-assigned unique ID for this managed resource.

Url string

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

id String

The provider-assigned unique ID for this managed resource.

url String

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

id string

The provider-assigned unique ID for this managed resource.

url string

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

id str

The provider-assigned unique ID for this managed resource.

url str

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

id String

The provider-assigned unique ID for this managed resource.

url String

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

Look up Existing MetadataSource Resource

Get an existing MetadataSource 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?: MetadataSourceState, opts?: CustomResourceOptions): MetadataSource
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[MetadataSourceAuthenticationArgs] = 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[MetadataSourceDefaultDateFormatArgs]] = None,
        description: Optional[str] = None,
        fields: Optional[Mapping[str, str]] = None,
        filters: Optional[Sequence[MetadataSourceFilterArgs]] = None,
        force_timezone: Optional[bool] = None,
        host_name: Optional[str] = None,
        manual_prefix_regexp: Optional[str] = None,
        multiline_processing_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        path: Optional[MetadataSourcePathArgs] = None,
        paused: Optional[bool] = None,
        scan_interval: Optional[int] = None,
        timezone: Optional[str] = None,
        url: Optional[str] = None,
        use_autoline_matching: Optional[bool] = None) -> MetadataSource
func GetMetadataSource(ctx *Context, name string, id IDInput, state *MetadataSourceState, opts ...ResourceOption) (*MetadataSource, error)
public static MetadataSource Get(string name, Input<string> id, MetadataSourceState? state, CustomResourceOptions? opts = null)
public static MetadataSource get(String name, Output<String> id, MetadataSourceState 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.MetadataSourceAuthenticationArgs

Authentication details for AWS access.

AutomaticDateParsing bool
Category string
CollectorId int
ContentType string

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

CutoffRelativeTime string
CutoffTimestamp int
DefaultDateFormats List<Pulumi.SumoLogic.Inputs.MetadataSourceDefaultDateFormatArgs>
Description string
Fields Dictionary<string, string>
Filters List<Pulumi.SumoLogic.Inputs.MetadataSourceFilterArgs>
ForceTimezone bool
HostName string
ManualPrefixRegexp string
MultilineProcessingEnabled bool
Name string
Path Pulumi.SumoLogic.Inputs.MetadataSourcePathArgs

The location to scan for new data.

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

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

UseAutolineMatching bool
Authentication MetadataSourceAuthenticationArgs

Authentication details for AWS access.

AutomaticDateParsing bool
Category string
CollectorId int
ContentType string

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

CutoffRelativeTime string
CutoffTimestamp int
DefaultDateFormats []MetadataSourceDefaultDateFormatArgs
Description string
Fields map[string]string
Filters []MetadataSourceFilterArgs
ForceTimezone bool
HostName string
ManualPrefixRegexp string
MultilineProcessingEnabled bool
Name string
Path MetadataSourcePathArgs

The location to scan for new data.

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

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

UseAutolineMatching bool
authentication MetadataSourceAuthenticationArgs

Authentication details for AWS access.

automaticDateParsing Boolean
category String
collectorId Integer
contentType String

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

cutoffRelativeTime String
cutoffTimestamp Integer
defaultDateFormats List<MetadataSourceDefaultDateFormatArgs>
description String
fields Map<String,String>
filters List<MetadataSourceFilterArgs>
forceTimezone Boolean
hostName String
manualPrefixRegexp String
multilineProcessingEnabled Boolean
name String
path MetadataSourcePathArgs

The location to scan for new data.

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

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

useAutolineMatching Boolean
authentication MetadataSourceAuthenticationArgs

Authentication details for AWS access.

automaticDateParsing boolean
category string
collectorId number
contentType string

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

cutoffRelativeTime string
cutoffTimestamp number
defaultDateFormats MetadataSourceDefaultDateFormatArgs[]
description string
fields {[key: string]: string}
filters MetadataSourceFilterArgs[]
forceTimezone boolean
hostName string
manualPrefixRegexp string
multilineProcessingEnabled boolean
name string
path MetadataSourcePathArgs

The location to scan for new data.

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

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

useAutolineMatching boolean
authentication MetadataSourceAuthenticationArgs

Authentication details for AWS access.

automatic_date_parsing bool
category str
collector_id int
content_type str

The content-type of the collected data. For Metadata source this is AwsMetadata. Details can be found in the Sumologic documentation for hosted sources.

cutoff_relative_time str
cutoff_timestamp int
default_date_formats Sequence[MetadataSourceDefaultDateFormatArgs]
description str
fields Mapping[str, str]
filters Sequence[MetadataSourceFilterArgs]
force_timezone bool
host_name str
manual_prefix_regexp str
multiline_processing_enabled bool
name str
path MetadataSourcePathArgs

The location to scan for new data.

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

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

use_autoline_matching bool
authentication Property Map

Authentication details for AWS access.

automaticDateParsing Boolean
category String
collectorId Number
contentType String

The content-type of the collected data. For Metadata source this is AwsMetadata. 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
hostName String
manualPrefixRegexp String
multilineProcessingEnabled Boolean
name String
path Property Map

The location to scan for new data.

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

The HTTP endpoint to use with SNS to notify Sumo Logic of new files.

useAutolineMatching Boolean

Supporting Types

MetadataSourceAuthentication

Type string

type of polling source. Only allowed value is AwsMetadataPath.

AccessKey string

Your AWS access key if using type S3BucketAuthentication

RoleArn string

Your AWS role ARN if using type AWSRoleBasedAuthentication. This is not supported for AWS China regions.

SecretKey string

Your AWS secret key if using type S3BucketAuthentication

Type string

type of polling source. Only allowed value is AwsMetadataPath.

AccessKey string

Your AWS access key if using type S3BucketAuthentication

RoleArn string

Your AWS role ARN if using type AWSRoleBasedAuthentication. This is not supported for AWS China regions.

SecretKey string

Your AWS secret key if using type S3BucketAuthentication

type String

type of polling source. Only allowed value is AwsMetadataPath.

accessKey String

Your AWS access key if using type S3BucketAuthentication

roleArn String

Your AWS role ARN if using type AWSRoleBasedAuthentication. This is not supported for AWS China regions.

secretKey String

Your AWS secret key if using type S3BucketAuthentication

type string

type of polling source. Only allowed value is AwsMetadataPath.

accessKey string

Your AWS access key if using type S3BucketAuthentication

roleArn string

Your AWS role ARN if using type AWSRoleBasedAuthentication. This is not supported for AWS China regions.

secretKey string

Your AWS secret key if using type S3BucketAuthentication

type str

type of polling source. Only allowed value is AwsMetadataPath.

access_key str

Your AWS access key if using type S3BucketAuthentication

role_arn str

Your AWS role ARN if using type AWSRoleBasedAuthentication. This is not supported for AWS China regions.

secret_key str

Your AWS secret key if using type S3BucketAuthentication

type String

type of polling source. Only allowed value is AwsMetadataPath.

accessKey String

Your AWS access key if using type S3BucketAuthentication

roleArn String

Your AWS role ARN if using type AWSRoleBasedAuthentication. This is not supported for AWS China regions.

secretKey String

Your AWS secret key if using type S3BucketAuthentication

MetadataSourceDefaultDateFormat

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

MetadataSourceFilter

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

MetadataSourcePath

Type string

type of polling source. Only allowed value is AwsMetadataPath.

LimitToNamespaces List<string>

List of namespaces. For AwsMetadataPath the only valid namespace is AWS/EC2.

LimitToRegions List<string>

List of Amazon regions.

TagFilters List<string>

Leave this field blank to collect all tags configured for the EC2 instance. To collect a subset of tags, follow the instructions in [Define EC2 tag filters][2]

Type string

type of polling source. Only allowed value is AwsMetadataPath.

LimitToNamespaces []string

List of namespaces. For AwsMetadataPath the only valid namespace is AWS/EC2.

LimitToRegions []string

List of Amazon regions.

TagFilters []string

Leave this field blank to collect all tags configured for the EC2 instance. To collect a subset of tags, follow the instructions in [Define EC2 tag filters][2]

type String

type of polling source. Only allowed value is AwsMetadataPath.

limitToNamespaces List<String>

List of namespaces. For AwsMetadataPath the only valid namespace is AWS/EC2.

limitToRegions List<String>

List of Amazon regions.

tagFilters List<String>

Leave this field blank to collect all tags configured for the EC2 instance. To collect a subset of tags, follow the instructions in [Define EC2 tag filters][2]

type string

type of polling source. Only allowed value is AwsMetadataPath.

limitToNamespaces string[]

List of namespaces. For AwsMetadataPath the only valid namespace is AWS/EC2.

limitToRegions string[]

List of Amazon regions.

tagFilters string[]

Leave this field blank to collect all tags configured for the EC2 instance. To collect a subset of tags, follow the instructions in [Define EC2 tag filters][2]

type str

type of polling source. Only allowed value is AwsMetadataPath.

limit_to_namespaces Sequence[str]

List of namespaces. For AwsMetadataPath the only valid namespace is AWS/EC2.

limit_to_regions Sequence[str]

List of Amazon regions.

tag_filters Sequence[str]

Leave this field blank to collect all tags configured for the EC2 instance. To collect a subset of tags, follow the instructions in [Define EC2 tag filters][2]

type String

type of polling source. Only allowed value is AwsMetadataPath.

limitToNamespaces List<String>

List of namespaces. For AwsMetadataPath the only valid namespace is AWS/EC2.

limitToRegions List<String>

List of Amazon regions.

tagFilters List<String>

Leave this field blank to collect all tags configured for the EC2 instance. To collect a subset of tags, follow the instructions in [Define EC2 tag filters][2]

Import

Metadata sources can be imported using the collector and source IDs (collector/source), e.g.hcl

 $ pulumi import sumologic:index/metadataSource:MetadataSource test 123/456

Metadata sources can be imported using the collector name and source name (collectorName/sourceName), e.g.hcl

 $ pulumi import sumologic:index/metadataSource:MetadataSource test my-test-collector/my-test-source

[1]https://help.sumologic.com/Send_Data/Sources/03Use_JSON_to_Configure_Sources/JSON_Parameters_for_Hosted_Sources [2]:https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/AWS-Metadata-(Tag)-Source#Define_EC2_tag_filters [3]:https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/AWS-Metadata-(Tag)-Source

Package Details

Repository
Sumo Logic pulumi/pulumi-sumologic
License
Apache-2.0
Notes

This Pulumi package is based on the sumologic Terraform Provider.