1. Pulumi Registry
  2. Sumo Logic
  3. API Docs
  4. KinesisMetricsSource
sumologic logo
Sumo Logic v0.13.0, Mar 27 23

sumologic.KinesisMetricsSource

Import

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

 $ pulumi import sumologic:index/kinesisMetricsSource:KinesisMetricsSource test 123/456

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

 $ pulumi import sumologic:index/kinesisMetricsSource:KinesisMetricsSource test my-test-collector/my-test-source

Create KinesisMetricsSource Resource

new KinesisMetricsSource(name: string, args: KinesisMetricsSourceArgs, opts?: CustomResourceOptions);
@overload
def KinesisMetricsSource(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         authentication: Optional[KinesisMetricsSourceAuthenticationArgs] = 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[KinesisMetricsSourceDefaultDateFormatArgs]] = None,
                         description: Optional[str] = None,
                         fields: Optional[Mapping[str, str]] = None,
                         filters: Optional[Sequence[KinesisMetricsSourceFilterArgs]] = None,
                         force_timezone: Optional[bool] = None,
                         host_name: Optional[str] = None,
                         manual_prefix_regexp: Optional[str] = None,
                         message_per_request: Optional[bool] = None,
                         multiline_processing_enabled: Optional[bool] = None,
                         name: Optional[str] = None,
                         path: Optional[KinesisMetricsSourcePathArgs] = None,
                         timezone: Optional[str] = None,
                         use_autoline_matching: Optional[bool] = None)
@overload
def KinesisMetricsSource(resource_name: str,
                         args: KinesisMetricsSourceArgs,
                         opts: Optional[ResourceOptions] = None)
func NewKinesisMetricsSource(ctx *Context, name string, args KinesisMetricsSourceArgs, opts ...ResourceOption) (*KinesisMetricsSource, error)
public KinesisMetricsSource(string name, KinesisMetricsSourceArgs args, CustomResourceOptions? opts = null)
public KinesisMetricsSource(String name, KinesisMetricsSourceArgs args)
public KinesisMetricsSource(String name, KinesisMetricsSourceArgs args, CustomResourceOptions options)

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

KinesisMetricsSource 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 KinesisMetricsSource resource accepts the following input properties:

Authentication Pulumi.SumoLogic.Inputs.KinesisMetricsSourceAuthenticationArgs

Authentication details for connecting to the S3 bucket.

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.KinesisMetricsSourcePathArgs

The location to scan for new data.

AutomaticDateParsing bool
Category string
CutoffRelativeTime string
CutoffTimestamp int
DefaultDateFormats List<Pulumi.SumoLogic.Inputs.KinesisMetricsSourceDefaultDateFormatArgs>
Description string
Fields Dictionary<string, string>
Filters List<Pulumi.SumoLogic.Inputs.KinesisMetricsSourceFilterArgs>
ForceTimezone bool
HostName string
ManualPrefixRegexp string
MessagePerRequest bool
MultilineProcessingEnabled bool
Name string
Timezone string
UseAutolineMatching bool
authentication KinesisMetricsSourceAuthenticationArgs

Authentication details for connecting to the S3 bucket.

collectorId number
contentType string

The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.

path KinesisMetricsSourcePathArgs

The location to scan for new data.

automaticDateParsing boolean
category string
cutoffRelativeTime string
cutoffTimestamp number
defaultDateFormats KinesisMetricsSourceDefaultDateFormatArgs[]
description string
fields {[key: string]: string}
filters KinesisMetricsSourceFilterArgs[]
forceTimezone boolean
hostName string
manualPrefixRegexp string
messagePerRequest boolean
multilineProcessingEnabled boolean
name string
timezone string
useAutolineMatching boolean
authentication Property Map

Authentication details for connecting to the S3 bucket.

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

The location to scan for new data.

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
messagePerRequest Boolean
multilineProcessingEnabled Boolean
name String
timezone String
useAutolineMatching Boolean

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Url string

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

Id string

The provider-assigned unique ID for this managed resource.

Url string

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

id String

The provider-assigned unique ID for this managed resource.

url String

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

id string

The provider-assigned unique ID for this managed resource.

url string

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

id str

The provider-assigned unique ID for this managed resource.

url str

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

id String

The provider-assigned unique ID for this managed resource.

url String

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

Look up Existing KinesisMetricsSource Resource

Get an existing KinesisMetricsSource 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?: KinesisMetricsSourceState, opts?: CustomResourceOptions): KinesisMetricsSource
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[KinesisMetricsSourceAuthenticationArgs] = 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[KinesisMetricsSourceDefaultDateFormatArgs]] = None,
        description: Optional[str] = None,
        fields: Optional[Mapping[str, str]] = None,
        filters: Optional[Sequence[KinesisMetricsSourceFilterArgs]] = None,
        force_timezone: Optional[bool] = None,
        host_name: Optional[str] = None,
        manual_prefix_regexp: Optional[str] = None,
        message_per_request: Optional[bool] = None,
        multiline_processing_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        path: Optional[KinesisMetricsSourcePathArgs] = None,
        timezone: Optional[str] = None,
        url: Optional[str] = None,
        use_autoline_matching: Optional[bool] = None) -> KinesisMetricsSource
func GetKinesisMetricsSource(ctx *Context, name string, id IDInput, state *KinesisMetricsSourceState, opts ...ResourceOption) (*KinesisMetricsSource, error)
public static KinesisMetricsSource Get(string name, Input<string> id, KinesisMetricsSourceState? state, CustomResourceOptions? opts = null)
public static KinesisMetricsSource get(String name, Output<String> id, KinesisMetricsSourceState 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.KinesisMetricsSourceAuthenticationArgs

Authentication details for connecting to the S3 bucket.

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.KinesisMetricsSourceDefaultDateFormatArgs>
Description string
Fields Dictionary<string, string>
Filters List<Pulumi.SumoLogic.Inputs.KinesisMetricsSourceFilterArgs>
ForceTimezone bool
HostName string
ManualPrefixRegexp string
MessagePerRequest bool
MultilineProcessingEnabled bool
Name string
Path Pulumi.SumoLogic.Inputs.KinesisMetricsSourcePathArgs

The location to scan for new data.

Timezone string
Url string

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

UseAutolineMatching bool
Authentication KinesisMetricsSourceAuthenticationArgs

Authentication details for connecting to the S3 bucket.

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 []KinesisMetricsSourceDefaultDateFormatArgs
Description string
Fields map[string]string
Filters []KinesisMetricsSourceFilterArgs
ForceTimezone bool
HostName string
ManualPrefixRegexp string
MessagePerRequest bool
MultilineProcessingEnabled bool
Name string
Path KinesisMetricsSourcePathArgs

The location to scan for new data.

Timezone string
Url string

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

UseAutolineMatching bool
authentication KinesisMetricsSourceAuthenticationArgs

Authentication details for connecting to the S3 bucket.

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<KinesisMetricsSourceDefaultDateFormatArgs>
description String
fields Map<String,String>
filters List<KinesisMetricsSourceFilterArgs>
forceTimezone Boolean
hostName String
manualPrefixRegexp String
messagePerRequest Boolean
multilineProcessingEnabled Boolean
name String
path KinesisMetricsSourcePathArgs

The location to scan for new data.

timezone String
url String

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

useAutolineMatching Boolean
authentication KinesisMetricsSourceAuthenticationArgs

Authentication details for connecting to the S3 bucket.

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 KinesisMetricsSourceDefaultDateFormatArgs[]
description string
fields {[key: string]: string}
filters KinesisMetricsSourceFilterArgs[]
forceTimezone boolean
hostName string
manualPrefixRegexp string
messagePerRequest boolean
multilineProcessingEnabled boolean
name string
path KinesisMetricsSourcePathArgs

The location to scan for new data.

timezone string
url string

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

useAutolineMatching boolean
authentication Property Map

Authentication details for connecting to the S3 bucket.

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
hostName String
manualPrefixRegexp String
messagePerRequest Boolean
multilineProcessingEnabled Boolean
name String
path Property Map

The location to scan for new data.

timezone String
url String

The HTTP endpoint to used while creating Kinesis Firehose on AWS.

useAutolineMatching Boolean

Supporting Types

KinesisMetricsSourceAuthentication

Type string

This value has to be set to TagFilters

AccessKey string

Your AWS access key if using type S3BucketAuthentication

RoleArn string

Your AWS role ARN if using type AWSRoleBasedAuthentication

SecretKey string

Your AWS secret key if using type S3BucketAuthentication

Type string

This value has to be set to TagFilters

AccessKey string

Your AWS access key if using type S3BucketAuthentication

RoleArn string

Your AWS role ARN if using type AWSRoleBasedAuthentication

SecretKey string

Your AWS secret key if using type S3BucketAuthentication

type String

This value has to be set to TagFilters

accessKey String

Your AWS access key if using type S3BucketAuthentication

roleArn String

Your AWS role ARN if using type AWSRoleBasedAuthentication

secretKey String

Your AWS secret key if using type S3BucketAuthentication

type string

This value has to be set to TagFilters

accessKey string

Your AWS access key if using type S3BucketAuthentication

roleArn string

Your AWS role ARN if using type AWSRoleBasedAuthentication

secretKey string

Your AWS secret key if using type S3BucketAuthentication

type str

This value has to be set to TagFilters

access_key str

Your AWS access key if using type S3BucketAuthentication

role_arn str

Your AWS role ARN if using type AWSRoleBasedAuthentication

secret_key str

Your AWS secret key if using type S3BucketAuthentication

type String

This value has to be set to TagFilters

accessKey String

Your AWS access key if using type S3BucketAuthentication

roleArn String

Your AWS role ARN if using type AWSRoleBasedAuthentication

secretKey String

Your AWS secret key if using type S3BucketAuthentication

KinesisMetricsSourceDefaultDateFormat

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

KinesisMetricsSourceFilter

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

KinesisMetricsSourcePath

Type string

This value has to be set to TagFilters

TagFilters List<Pulumi.SumoLogic.Inputs.KinesisMetricsSourcePathTagFilter>

Tag filters allow you to filter the CloudWatch metrics you collect by the AWS tags you have assigned to your AWS resources. You can define tag filters for each supported namespace. If you do not define any tag filters, all metrics will be collected for the regions and namespaces you configured for the source above. More info on tag filters can be found here

Type string

This value has to be set to TagFilters

TagFilters []KinesisMetricsSourcePathTagFilter

Tag filters allow you to filter the CloudWatch metrics you collect by the AWS tags you have assigned to your AWS resources. You can define tag filters for each supported namespace. If you do not define any tag filters, all metrics will be collected for the regions and namespaces you configured for the source above. More info on tag filters can be found here

type String

This value has to be set to TagFilters

tagFilters List<KinesisMetricsSourcePathTagFilter>

Tag filters allow you to filter the CloudWatch metrics you collect by the AWS tags you have assigned to your AWS resources. You can define tag filters for each supported namespace. If you do not define any tag filters, all metrics will be collected for the regions and namespaces you configured for the source above. More info on tag filters can be found here

type string

This value has to be set to TagFilters

tagFilters KinesisMetricsSourcePathTagFilter[]

Tag filters allow you to filter the CloudWatch metrics you collect by the AWS tags you have assigned to your AWS resources. You can define tag filters for each supported namespace. If you do not define any tag filters, all metrics will be collected for the regions and namespaces you configured for the source above. More info on tag filters can be found here

type str

This value has to be set to TagFilters

tag_filters Sequence[KinesisMetricsSourcePathTagFilter]

Tag filters allow you to filter the CloudWatch metrics you collect by the AWS tags you have assigned to your AWS resources. You can define tag filters for each supported namespace. If you do not define any tag filters, all metrics will be collected for the regions and namespaces you configured for the source above. More info on tag filters can be found here

type String

This value has to be set to TagFilters

tagFilters List<Property Map>

Tag filters allow you to filter the CloudWatch metrics you collect by the AWS tags you have assigned to your AWS resources. You can define tag filters for each supported namespace. If you do not define any tag filters, all metrics will be collected for the regions and namespaces you configured for the source above. More info on tag filters can be found here

KinesisMetricsSourcePathTagFilter

Namespace string

Namespace for which you want to define the tag filters. Use value as All to apply the tag filter for all namespaces.

Tags List<string>

List of key-value pairs of tag filters. Eg: ["k3=v3"]

Type string

This value has to be set to TagFilters

Namespace string

Namespace for which you want to define the tag filters. Use value as All to apply the tag filter for all namespaces.

Tags []string

List of key-value pairs of tag filters. Eg: ["k3=v3"]

Type string

This value has to be set to TagFilters

namespace String

Namespace for which you want to define the tag filters. Use value as All to apply the tag filter for all namespaces.

tags List<String>

List of key-value pairs of tag filters. Eg: ["k3=v3"]

type String

This value has to be set to TagFilters

namespace string

Namespace for which you want to define the tag filters. Use value as All to apply the tag filter for all namespaces.

tags string[]

List of key-value pairs of tag filters. Eg: ["k3=v3"]

type string

This value has to be set to TagFilters

namespace str

Namespace for which you want to define the tag filters. Use value as All to apply the tag filter for all namespaces.

tags Sequence[str]

List of key-value pairs of tag filters. Eg: ["k3=v3"]

type str

This value has to be set to TagFilters

namespace String

Namespace for which you want to define the tag filters. Use value as All to apply the tag filter for all namespaces.

tags List<String>

List of key-value pairs of tag filters. Eg: ["k3=v3"]

type String

This value has to be set to TagFilters

Package Details

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

This Pulumi package is based on the sumologic Terraform Provider.