sumologic.S3Source
Explore with Pulumi AI
Provides a Sumologic AWS S3 Source.
IMPORTANT: The AWS credentials are stored in plain-text in the state. This is a potential security issue.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";
const collector = new sumologic.Collector("collector", {
name: "my-collector",
description: "Just testing this",
});
const s3Source = new sumologic.S3Source("s3_source", {
name: "Amazon S3 Source",
description: "My description",
category: "aws/s3",
contentType: "AwsS3Bucket",
scanInterval: 300000,
paused: false,
collectorId: collector.id,
authentication: {
type: "S3BucketAuthentication",
accessKey: "someKey",
secretKey: "******",
},
path: {
type: "S3BucketPathExpression",
bucketName: "Bucket1",
pathExpression: "*",
},
});
import pulumi
import pulumi_sumologic as sumologic
collector = sumologic.Collector("collector",
name="my-collector",
description="Just testing this")
s3_source = sumologic.S3Source("s3_source",
name="Amazon S3 Source",
description="My description",
category="aws/s3",
content_type="AwsS3Bucket",
scan_interval=300000,
paused=False,
collector_id=collector.id,
authentication={
"type": "S3BucketAuthentication",
"access_key": "someKey",
"secret_key": "******",
},
path={
"type": "S3BucketPathExpression",
"bucket_name": "Bucket1",
"path_expression": "*",
})
package main
import (
"github.com/pulumi/pulumi-sumologic/sdk/go/sumologic"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
collector, err := sumologic.NewCollector(ctx, "collector", &sumologic.CollectorArgs{
Name: pulumi.String("my-collector"),
Description: pulumi.String("Just testing this"),
})
if err != nil {
return err
}
_, err = sumologic.NewS3Source(ctx, "s3_source", &sumologic.S3SourceArgs{
Name: pulumi.String("Amazon S3 Source"),
Description: pulumi.String("My description"),
Category: pulumi.String("aws/s3"),
ContentType: pulumi.String("AwsS3Bucket"),
ScanInterval: pulumi.Int(300000),
Paused: pulumi.Bool(false),
CollectorId: collector.ID(),
Authentication: &sumologic.S3SourceAuthenticationArgs{
Type: pulumi.String("S3BucketAuthentication"),
AccessKey: pulumi.String("someKey"),
SecretKey: pulumi.String("******"),
},
Path: &sumologic.S3SourcePathArgs{
Type: pulumi.String("S3BucketPathExpression"),
BucketName: pulumi.String("Bucket1"),
PathExpression: pulumi.String("*"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;
return await Deployment.RunAsync(() =>
{
var collector = new SumoLogic.Collector("collector", new()
{
Name = "my-collector",
Description = "Just testing this",
});
var s3Source = new SumoLogic.S3Source("s3_source", new()
{
Name = "Amazon S3 Source",
Description = "My description",
Category = "aws/s3",
ContentType = "AwsS3Bucket",
ScanInterval = 300000,
Paused = false,
CollectorId = collector.Id,
Authentication = new SumoLogic.Inputs.S3SourceAuthenticationArgs
{
Type = "S3BucketAuthentication",
AccessKey = "someKey",
SecretKey = "******",
},
Path = new SumoLogic.Inputs.S3SourcePathArgs
{
Type = "S3BucketPathExpression",
BucketName = "Bucket1",
PathExpression = "*",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.Collector;
import com.pulumi.sumologic.CollectorArgs;
import com.pulumi.sumologic.S3Source;
import com.pulumi.sumologic.S3SourceArgs;
import com.pulumi.sumologic.inputs.S3SourceAuthenticationArgs;
import com.pulumi.sumologic.inputs.S3SourcePathArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var collector = new Collector("collector", CollectorArgs.builder()
.name("my-collector")
.description("Just testing this")
.build());
var s3Source = new S3Source("s3Source", S3SourceArgs.builder()
.name("Amazon S3 Source")
.description("My description")
.category("aws/s3")
.contentType("AwsS3Bucket")
.scanInterval(300000)
.paused(false)
.collectorId(collector.id())
.authentication(S3SourceAuthenticationArgs.builder()
.type("S3BucketAuthentication")
.accessKey("someKey")
.secretKey("******")
.build())
.path(S3SourcePathArgs.builder()
.type("S3BucketPathExpression")
.bucketName("Bucket1")
.pathExpression("*")
.build())
.build());
}
}
resources:
s3Source:
type: sumologic:S3Source
name: s3_source
properties:
name: Amazon S3 Source
description: My description
category: aws/s3
contentType: AwsS3Bucket
scanInterval: 300000
paused: false
collectorId: ${collector.id}
authentication:
type: S3BucketAuthentication
accessKey: someKey
secretKey: '******'
path:
type: S3BucketPathExpression
bucketName: Bucket1
pathExpression: '*'
collector:
type: sumologic:Collector
properties:
name: my-collector
description: Just testing this
Create S3Source Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new S3Source(name: string, args: S3SourceArgs, opts?: CustomResourceOptions);
@overload
def S3Source(resource_name: str,
args: S3SourceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def S3Source(resource_name: str,
opts: Optional[ResourceOptions] = None,
content_type: Optional[str] = None,
path: Optional[S3SourcePathArgs] = None,
authentication: Optional[S3SourceAuthenticationArgs] = None,
collector_id: Optional[int] = None,
filters: Optional[Sequence[S3SourceFilterArgs]] = None,
manual_prefix_regexp: Optional[str] = None,
cutoff_timestamp: Optional[int] = None,
default_date_formats: Optional[Sequence[S3SourceDefaultDateFormatArgs]] = None,
description: Optional[str] = None,
fields: Optional[Mapping[str, str]] = None,
category: Optional[str] = None,
force_timezone: Optional[bool] = None,
host_name: Optional[str] = None,
cutoff_relative_time: 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 NewS3Source(ctx *Context, name string, args S3SourceArgs, opts ...ResourceOption) (*S3Source, error)
public S3Source(string name, S3SourceArgs args, CustomResourceOptions? opts = null)
public S3Source(String name, S3SourceArgs args)
public S3Source(String name, S3SourceArgs args, CustomResourceOptions options)
type: sumologic:S3Source
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 S3SourceArgs
- 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 S3SourceArgs
- 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 S3SourceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args S3SourceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args S3SourceArgs
- 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 s3sourceResource = new SumoLogic.S3Source("s3sourceResource", new()
{
ContentType = "string",
Path = new SumoLogic.Inputs.S3SourcePathArgs
{
Type = "string",
LimitToServices = new[]
{
"string",
},
CustomServices = new[]
{
new SumoLogic.Inputs.S3SourcePathCustomServiceArgs
{
Prefixes = new[]
{
"string",
},
ServiceName = "string",
},
},
EventHubName = "string",
LimitToNamespaces = new[]
{
"string",
},
LimitToRegions = new[]
{
"string",
},
BucketName = "string",
Namespace = "string",
PathExpression = "string",
Region = "string",
SnsTopicOrSubscriptionArns = new[]
{
new SumoLogic.Inputs.S3SourcePathSnsTopicOrSubscriptionArnArgs
{
Arn = "string",
IsSuccess = false,
},
},
TagFilters = new[]
{
new SumoLogic.Inputs.S3SourcePathTagFilterArgs
{
Namespace = "string",
Tags = new[]
{
"string",
},
Type = "string",
},
},
ConsumerGroup = "string",
UseVersionedApi = false,
},
Authentication = new SumoLogic.Inputs.S3SourceAuthenticationArgs
{
Type = "string",
ProjectId = "string",
Region = "string",
ClientEmail = "string",
ClientId = "string",
ClientX509CertUrl = "string",
PrivateKey = "string",
AuthUri = "string",
AccessKey = "string",
PrivateKeyId = "string",
RoleArn = "string",
SecretKey = "string",
SharedAccessPolicyKey = "string",
SharedAccessPolicyName = "string",
TokenUri = "string",
AuthProviderX509CertUrl = "string",
},
CollectorId = 0,
Filters = new[]
{
new SumoLogic.Inputs.S3SourceFilterArgs
{
FilterType = "string",
Name = "string",
Regexp = "string",
Mask = "string",
},
},
ManualPrefixRegexp = "string",
CutoffTimestamp = 0,
DefaultDateFormats = new[]
{
new SumoLogic.Inputs.S3SourceDefaultDateFormatArgs
{
Format = "string",
Locator = "string",
},
},
Description = "string",
Fields =
{
{ "string", "string" },
},
Category = "string",
ForceTimezone = false,
HostName = "string",
CutoffRelativeTime = "string",
MultilineProcessingEnabled = false,
Name = "string",
AutomaticDateParsing = false,
Paused = false,
ScanInterval = 0,
Timezone = "string",
UseAutolineMatching = false,
});
example, err := sumologic.NewS3Source(ctx, "s3sourceResource", &sumologic.S3SourceArgs{
ContentType: pulumi.String("string"),
Path: &sumologic.S3SourcePathArgs{
Type: pulumi.String("string"),
LimitToServices: pulumi.StringArray{
pulumi.String("string"),
},
CustomServices: sumologic.S3SourcePathCustomServiceArray{
&sumologic.S3SourcePathCustomServiceArgs{
Prefixes: pulumi.StringArray{
pulumi.String("string"),
},
ServiceName: pulumi.String("string"),
},
},
EventHubName: pulumi.String("string"),
LimitToNamespaces: pulumi.StringArray{
pulumi.String("string"),
},
LimitToRegions: pulumi.StringArray{
pulumi.String("string"),
},
BucketName: pulumi.String("string"),
Namespace: pulumi.String("string"),
PathExpression: pulumi.String("string"),
Region: pulumi.String("string"),
SnsTopicOrSubscriptionArns: sumologic.S3SourcePathSnsTopicOrSubscriptionArnArray{
&sumologic.S3SourcePathSnsTopicOrSubscriptionArnArgs{
Arn: pulumi.String("string"),
IsSuccess: pulumi.Bool(false),
},
},
TagFilters: sumologic.S3SourcePathTagFilterArray{
&sumologic.S3SourcePathTagFilterArgs{
Namespace: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
},
},
ConsumerGroup: pulumi.String("string"),
UseVersionedApi: pulumi.Bool(false),
},
Authentication: &sumologic.S3SourceAuthenticationArgs{
Type: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Region: pulumi.String("string"),
ClientEmail: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientX509CertUrl: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
AuthUri: pulumi.String("string"),
AccessKey: pulumi.String("string"),
PrivateKeyId: pulumi.String("string"),
RoleArn: pulumi.String("string"),
SecretKey: pulumi.String("string"),
SharedAccessPolicyKey: pulumi.String("string"),
SharedAccessPolicyName: pulumi.String("string"),
TokenUri: pulumi.String("string"),
AuthProviderX509CertUrl: pulumi.String("string"),
},
CollectorId: pulumi.Int(0),
Filters: sumologic.S3SourceFilterArray{
&sumologic.S3SourceFilterArgs{
FilterType: pulumi.String("string"),
Name: pulumi.String("string"),
Regexp: pulumi.String("string"),
Mask: pulumi.String("string"),
},
},
ManualPrefixRegexp: pulumi.String("string"),
CutoffTimestamp: pulumi.Int(0),
DefaultDateFormats: sumologic.S3SourceDefaultDateFormatArray{
&sumologic.S3SourceDefaultDateFormatArgs{
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),
HostName: pulumi.String("string"),
CutoffRelativeTime: 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 s3sourceResource = new S3Source("s3sourceResource", S3SourceArgs.builder()
.contentType("string")
.path(S3SourcePathArgs.builder()
.type("string")
.limitToServices("string")
.customServices(S3SourcePathCustomServiceArgs.builder()
.prefixes("string")
.serviceName("string")
.build())
.eventHubName("string")
.limitToNamespaces("string")
.limitToRegions("string")
.bucketName("string")
.namespace("string")
.pathExpression("string")
.region("string")
.snsTopicOrSubscriptionArns(S3SourcePathSnsTopicOrSubscriptionArnArgs.builder()
.arn("string")
.isSuccess(false)
.build())
.tagFilters(S3SourcePathTagFilterArgs.builder()
.namespace("string")
.tags("string")
.type("string")
.build())
.consumerGroup("string")
.useVersionedApi(false)
.build())
.authentication(S3SourceAuthenticationArgs.builder()
.type("string")
.projectId("string")
.region("string")
.clientEmail("string")
.clientId("string")
.clientX509CertUrl("string")
.privateKey("string")
.authUri("string")
.accessKey("string")
.privateKeyId("string")
.roleArn("string")
.secretKey("string")
.sharedAccessPolicyKey("string")
.sharedAccessPolicyName("string")
.tokenUri("string")
.authProviderX509CertUrl("string")
.build())
.collectorId(0)
.filters(S3SourceFilterArgs.builder()
.filterType("string")
.name("string")
.regexp("string")
.mask("string")
.build())
.manualPrefixRegexp("string")
.cutoffTimestamp(0)
.defaultDateFormats(S3SourceDefaultDateFormatArgs.builder()
.format("string")
.locator("string")
.build())
.description("string")
.fields(Map.of("string", "string"))
.category("string")
.forceTimezone(false)
.hostName("string")
.cutoffRelativeTime("string")
.multilineProcessingEnabled(false)
.name("string")
.automaticDateParsing(false)
.paused(false)
.scanInterval(0)
.timezone("string")
.useAutolineMatching(false)
.build());
s3source_resource = sumologic.S3Source("s3sourceResource",
content_type="string",
path=sumologic.S3SourcePathArgs(
type="string",
limit_to_services=["string"],
custom_services=[sumologic.S3SourcePathCustomServiceArgs(
prefixes=["string"],
service_name="string",
)],
event_hub_name="string",
limit_to_namespaces=["string"],
limit_to_regions=["string"],
bucket_name="string",
namespace="string",
path_expression="string",
region="string",
sns_topic_or_subscription_arns=[sumologic.S3SourcePathSnsTopicOrSubscriptionArnArgs(
arn="string",
is_success=False,
)],
tag_filters=[sumologic.S3SourcePathTagFilterArgs(
namespace="string",
tags=["string"],
type="string",
)],
consumer_group="string",
use_versioned_api=False,
),
authentication=sumologic.S3SourceAuthenticationArgs(
type="string",
project_id="string",
region="string",
client_email="string",
client_id="string",
client_x509_cert_url="string",
private_key="string",
auth_uri="string",
access_key="string",
private_key_id="string",
role_arn="string",
secret_key="string",
shared_access_policy_key="string",
shared_access_policy_name="string",
token_uri="string",
auth_provider_x509_cert_url="string",
),
collector_id=0,
filters=[sumologic.S3SourceFilterArgs(
filter_type="string",
name="string",
regexp="string",
mask="string",
)],
manual_prefix_regexp="string",
cutoff_timestamp=0,
default_date_formats=[sumologic.S3SourceDefaultDateFormatArgs(
format="string",
locator="string",
)],
description="string",
fields={
"string": "string",
},
category="string",
force_timezone=False,
host_name="string",
cutoff_relative_time="string",
multiline_processing_enabled=False,
name="string",
automatic_date_parsing=False,
paused=False,
scan_interval=0,
timezone="string",
use_autoline_matching=False)
const s3sourceResource = new sumologic.S3Source("s3sourceResource", {
contentType: "string",
path: {
type: "string",
limitToServices: ["string"],
customServices: [{
prefixes: ["string"],
serviceName: "string",
}],
eventHubName: "string",
limitToNamespaces: ["string"],
limitToRegions: ["string"],
bucketName: "string",
namespace: "string",
pathExpression: "string",
region: "string",
snsTopicOrSubscriptionArns: [{
arn: "string",
isSuccess: false,
}],
tagFilters: [{
namespace: "string",
tags: ["string"],
type: "string",
}],
consumerGroup: "string",
useVersionedApi: false,
},
authentication: {
type: "string",
projectId: "string",
region: "string",
clientEmail: "string",
clientId: "string",
clientX509CertUrl: "string",
privateKey: "string",
authUri: "string",
accessKey: "string",
privateKeyId: "string",
roleArn: "string",
secretKey: "string",
sharedAccessPolicyKey: "string",
sharedAccessPolicyName: "string",
tokenUri: "string",
authProviderX509CertUrl: "string",
},
collectorId: 0,
filters: [{
filterType: "string",
name: "string",
regexp: "string",
mask: "string",
}],
manualPrefixRegexp: "string",
cutoffTimestamp: 0,
defaultDateFormats: [{
format: "string",
locator: "string",
}],
description: "string",
fields: {
string: "string",
},
category: "string",
forceTimezone: false,
hostName: "string",
cutoffRelativeTime: "string",
multilineProcessingEnabled: false,
name: "string",
automaticDateParsing: false,
paused: false,
scanInterval: 0,
timezone: "string",
useAutolineMatching: false,
});
type: sumologic:S3Source
properties:
authentication:
accessKey: string
authProviderX509CertUrl: string
authUri: string
clientEmail: string
clientId: string
clientX509CertUrl: string
privateKey: string
privateKeyId: string
projectId: string
region: string
roleArn: string
secretKey: string
sharedAccessPolicyKey: string
sharedAccessPolicyName: string
tokenUri: string
type: string
automaticDateParsing: false
category: string
collectorId: 0
contentType: string
cutoffRelativeTime: string
cutoffTimestamp: 0
defaultDateFormats:
- format: string
locator: string
description: string
fields:
string: string
filters:
- filterType: string
mask: string
name: string
regexp: string
forceTimezone: false
hostName: string
manualPrefixRegexp: string
multilineProcessingEnabled: false
name: string
path:
bucketName: string
consumerGroup: string
customServices:
- prefixes:
- string
serviceName: string
eventHubName: string
limitToNamespaces:
- string
limitToRegions:
- string
limitToServices:
- string
namespace: string
pathExpression: string
region: string
snsTopicOrSubscriptionArns:
- arn: string
isSuccess: false
tagFilters:
- namespace: string
tags:
- string
type: string
type: string
useVersionedApi: false
paused: false
scanInterval: 0
timezone: string
useAutolineMatching: false
S3Source 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 S3Source resource accepts the following input properties:
- Authentication
Pulumi.
Sumo Logic. Inputs. S3Source Authentication - Authentication details for connecting to the S3 bucket.
- 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. S3Source Path - The location to scan for new data.
- Automatic
Date boolParsing - Category string
- Cutoff
Relative stringTime - Cutoff
Timestamp int - Default
Date List<Pulumi.Formats Sumo Logic. Inputs. S3Source Default Date Format> - Description string
- Fields Dictionary<string, string>
- Filters
List<Pulumi.
Sumo Logic. Inputs. S3Source Filter> - Force
Timezone bool - 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
S3Source
Authentication Args - Authentication details for connecting to the S3 bucket.
- 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
S3Source
Path Args - The location to scan for new data.
- Automatic
Date boolParsing - Category string
- Cutoff
Relative stringTime - Cutoff
Timestamp int - Default
Date []S3SourceFormats Default Date Format Args - Description string
- Fields map[string]string
- Filters
[]S3Source
Filter Args - Force
Timezone bool - 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
S3Source
Authentication - Authentication details for connecting to the S3 bucket.
- 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
S3Source
Path - The location to scan for new data.
- automatic
Date BooleanParsing - category String
- cutoff
Relative StringTime - cutoff
Timestamp Integer - default
Date List<S3SourceFormats Default Date Format> - description String
- fields Map<String,String>
- filters
List<S3Source
Filter> - force
Timezone Boolean - 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
S3Source
Authentication - Authentication details for connecting to the S3 bucket.
- 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
S3Source
Path - The location to scan for new data.
- automatic
Date booleanParsing - category string
- cutoff
Relative stringTime - cutoff
Timestamp number - default
Date S3SourceFormats Default Date Format[] - description string
- fields {[key: string]: string}
- filters
S3Source
Filter[] - force
Timezone boolean - 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
S3Source
Authentication Args - Authentication details for connecting to the S3 bucket.
- 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
S3Source
Path Args - The location to scan for new data.
- automatic_
date_ boolparsing - category str
- cutoff_
relative_ strtime - cutoff_
timestamp int - default_
date_ Sequence[S3Sourceformats Default Date Format Args] - description str
- fields Mapping[str, str]
- filters
Sequence[S3Source
Filter Args] - force_
timezone bool - 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 S3 bucket.
- 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
- The location to scan for new data.
- 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 - 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 S3Source 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 S3Source Resource
Get an existing S3Source 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?: S3SourceState, opts?: CustomResourceOptions): S3Source
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
authentication: Optional[S3SourceAuthenticationArgs] = 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[S3SourceDefaultDateFormatArgs]] = None,
description: Optional[str] = None,
fields: Optional[Mapping[str, str]] = None,
filters: Optional[Sequence[S3SourceFilterArgs]] = 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[S3SourcePathArgs] = None,
paused: Optional[bool] = None,
scan_interval: Optional[int] = None,
timezone: Optional[str] = None,
url: Optional[str] = None,
use_autoline_matching: Optional[bool] = None) -> S3Source
func GetS3Source(ctx *Context, name string, id IDInput, state *S3SourceState, opts ...ResourceOption) (*S3Source, error)
public static S3Source Get(string name, Input<string> id, S3SourceState? state, CustomResourceOptions? opts = null)
public static S3Source get(String name, Output<String> id, S3SourceState 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.
- Authentication
Pulumi.
Sumo Logic. Inputs. S3Source Authentication - Authentication details for connecting to the S3 bucket.
- 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. S3Source Default Date Format> - Description string
- Fields Dictionary<string, string>
- Filters
List<Pulumi.
Sumo Logic. Inputs. S3Source Filter> - Force
Timezone bool - Host
Name string - Manual
Prefix stringRegexp - Multiline
Processing boolEnabled - Name string
- Path
Pulumi.
Sumo Logic. Inputs. S3Source Path - 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 string
- Url string
- The HTTP endpoint to use with SNS to notify Sumo Logic of new files.
- Use
Autoline boolMatching
- Authentication
S3Source
Authentication Args - Authentication details for connecting to the S3 bucket.
- 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 []S3SourceFormats Default Date Format Args - Description string
- Fields map[string]string
- Filters
[]S3Source
Filter Args - Force
Timezone bool - Host
Name string - Manual
Prefix stringRegexp - Multiline
Processing boolEnabled - Name string
- Path
S3Source
Path Args - 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 string
- Url string
- The HTTP endpoint to use with SNS to notify Sumo Logic of new files.
- Use
Autoline boolMatching
- authentication
S3Source
Authentication - Authentication details for connecting to the S3 bucket.
- 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<S3SourceFormats Default Date Format> - description String
- fields Map<String,String>
- filters
List<S3Source
Filter> - force
Timezone Boolean - host
Name String - manual
Prefix StringRegexp - multiline
Processing BooleanEnabled - name String
- path
S3Source
Path - The location to scan for new data.
- 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
- The HTTP endpoint to use with SNS to notify Sumo Logic of new files.
- use
Autoline BooleanMatching
- authentication
S3Source
Authentication - Authentication details for connecting to the S3 bucket.
- 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 S3SourceFormats Default Date Format[] - description string
- fields {[key: string]: string}
- filters
S3Source
Filter[] - force
Timezone boolean - host
Name string - manual
Prefix stringRegexp - multiline
Processing booleanEnabled - name string
- path
S3Source
Path - The location to scan for new data.
- 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
- The HTTP endpoint to use with SNS to notify Sumo Logic of new files.
- use
Autoline booleanMatching
- authentication
S3Source
Authentication Args - Authentication details for connecting to the S3 bucket.
- 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[S3Sourceformats Default Date Format Args] - description str
- fields Mapping[str, str]
- filters
Sequence[S3Source
Filter Args] - force_
timezone bool - host_
name str - manual_
prefix_ strregexp - multiline_
processing_ boolenabled - name str
- path
S3Source
Path Args - 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_ boolmatching
- authentication Property Map
- Authentication details for connecting to the S3 bucket.
- 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 - host
Name String - manual
Prefix StringRegexp - multiline
Processing BooleanEnabled - 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.
- 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
- The HTTP endpoint to use with SNS to notify Sumo Logic of new files.
- use
Autoline BooleanMatching
Supporting Types
S3SourceAuthentication, S3SourceAuthenticationArgs
- Type string
- Must be either
S3BucketAuthentication
orAWSRoleBasedAuthentication
. - Access
Key string - Your AWS access key if using type
S3BucketAuthentication
. - Auth
Provider stringX509Cert Url - Auth
Uri string - Client
Email string - Client
Id string - Client
X509Cert stringUrl - Private
Key string - Private
Key stringId - Project
Id string - Region string
- Your AWS Bucket region.
- Role
Arn string - Your AWS role ARN if using type
AWSRoleBasedAuthentication
. This is not supported for AWS China regions. - Secret
Key string - Your AWS secret key if using type
S3BucketAuthentication
. - string
- string
- Token
Uri string
- Type string
- Must be either
S3BucketAuthentication
orAWSRoleBasedAuthentication
. - Access
Key string - Your AWS access key if using type
S3BucketAuthentication
. - Auth
Provider stringX509Cert Url - Auth
Uri string - Client
Email string - Client
Id string - Client
X509Cert stringUrl - Private
Key string - Private
Key stringId - Project
Id string - Region string
- Your AWS Bucket region.
- Role
Arn string - Your AWS role ARN if using type
AWSRoleBasedAuthentication
. This is not supported for AWS China regions. - Secret
Key string - Your AWS secret key if using type
S3BucketAuthentication
. - string
- string
- Token
Uri string
- type String
- Must be either
S3BucketAuthentication
orAWSRoleBasedAuthentication
. - access
Key String - Your AWS access key if using type
S3BucketAuthentication
. - auth
Provider StringX509Cert Url - auth
Uri String - client
Email String - client
Id String - client
X509Cert StringUrl - private
Key String - private
Key StringId - project
Id String - region String
- Your AWS Bucket region.
- role
Arn String - Your AWS role ARN if using type
AWSRoleBasedAuthentication
. This is not supported for AWS China regions. - secret
Key String - Your AWS secret key if using type
S3BucketAuthentication
. - String
- String
- token
Uri String
- type string
- Must be either
S3BucketAuthentication
orAWSRoleBasedAuthentication
. - access
Key string - Your AWS access key if using type
S3BucketAuthentication
. - auth
Provider stringX509Cert Url - auth
Uri string - client
Email string - client
Id string - client
X509Cert stringUrl - private
Key string - private
Key stringId - project
Id string - region string
- Your AWS Bucket region.
- role
Arn string - Your AWS role ARN if using type
AWSRoleBasedAuthentication
. This is not supported for AWS China regions. - secret
Key string - Your AWS secret key if using type
S3BucketAuthentication
. - string
- string
- token
Uri string
- type str
- Must be either
S3BucketAuthentication
orAWSRoleBasedAuthentication
. - access_
key str - Your AWS access key if using type
S3BucketAuthentication
. - auth_
provider_ strx509_ cert_ url - auth_
uri str - client_
email str - client_
id str - client_
x509_ strcert_ url - private_
key str - private_
key_ strid - project_
id str - region str
- Your AWS Bucket region.
- 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
. - str
- str
- token_
uri str
- type String
- Must be either
S3BucketAuthentication
orAWSRoleBasedAuthentication
. - access
Key String - Your AWS access key if using type
S3BucketAuthentication
. - auth
Provider StringX509Cert Url - auth
Uri String - client
Email String - client
Id String - client
X509Cert StringUrl - private
Key String - private
Key StringId - project
Id String - region String
- Your AWS Bucket region.
- role
Arn String - Your AWS role ARN if using type
AWSRoleBasedAuthentication
. This is not supported for AWS China regions. - secret
Key String - Your AWS secret key if using type
S3BucketAuthentication
. - String
- String
- token
Uri String
S3SourceDefaultDateFormat, S3SourceDefaultDateFormatArgs
S3SourceFilter, S3SourceFilterArgs
- 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
S3SourcePath, S3SourcePathArgs
- Type string
- type of polling source. This has to be
S3BucketPathExpression
forS3 source
. - Bucket
Name string - The name of the bucket.
- Consumer
Group string - Custom
Services List<Pulumi.Sumo Logic. Inputs. S3Source Path Custom Service> - Event
Hub stringName - Limit
To List<string>Namespaces - Limit
To List<string>Regions - Limit
To List<string>Services - Namespace string
- Path
Expression string - The path to the data.
- Region string
- Your AWS Bucket region.
- Sns
Topic List<Pulumi.Or Subscription Arns Sumo Logic. Inputs. S3Source Path Sns Topic Or Subscription Arn> - This is a computed field for SNS topic/subscription ARN.
- Tag
Filters List<Pulumi.Sumo Logic. Inputs. S3Source Path Tag Filter> - Use
Versioned boolApi - Whether to Use AWS versioned APIs. Default is set to
true
. If you're collecting from a Cisco Umbrella bucket this must be set tofalse
.
- Type string
- type of polling source. This has to be
S3BucketPathExpression
forS3 source
. - Bucket
Name string - The name of the bucket.
- Consumer
Group string - Custom
Services []S3SourcePath Custom Service - Event
Hub stringName - Limit
To []stringNamespaces - Limit
To []stringRegions - Limit
To []stringServices - Namespace string
- Path
Expression string - The path to the data.
- Region string
- Your AWS Bucket region.
- Sns
Topic []S3SourceOr Subscription Arns Path Sns Topic Or Subscription Arn - This is a computed field for SNS topic/subscription ARN.
- Tag
Filters []S3SourcePath Tag Filter - Use
Versioned boolApi - Whether to Use AWS versioned APIs. Default is set to
true
. If you're collecting from a Cisco Umbrella bucket this must be set tofalse
.
- type String
- type of polling source. This has to be
S3BucketPathExpression
forS3 source
. - bucket
Name String - The name of the bucket.
- consumer
Group String - custom
Services List<S3SourcePath Custom Service> - event
Hub StringName - limit
To List<String>Namespaces - limit
To List<String>Regions - limit
To List<String>Services - namespace String
- path
Expression String - The path to the data.
- region String
- Your AWS Bucket region.
- sns
Topic List<S3SourceOr Subscription Arns Path Sns Topic Or Subscription Arn> - This is a computed field for SNS topic/subscription ARN.
- tag
Filters List<S3SourcePath Tag Filter> - use
Versioned BooleanApi - Whether to Use AWS versioned APIs. Default is set to
true
. If you're collecting from a Cisco Umbrella bucket this must be set tofalse
.
- type string
- type of polling source. This has to be
S3BucketPathExpression
forS3 source
. - bucket
Name string - The name of the bucket.
- consumer
Group string - custom
Services S3SourcePath Custom Service[] - event
Hub stringName - limit
To string[]Namespaces - limit
To string[]Regions - limit
To string[]Services - namespace string
- path
Expression string - The path to the data.
- region string
- Your AWS Bucket region.
- sns
Topic S3SourceOr Subscription Arns Path Sns Topic Or Subscription Arn[] - This is a computed field for SNS topic/subscription ARN.
- tag
Filters S3SourcePath Tag Filter[] - use
Versioned booleanApi - Whether to Use AWS versioned APIs. Default is set to
true
. If you're collecting from a Cisco Umbrella bucket this must be set tofalse
.
- type str
- type of polling source. This has to be
S3BucketPathExpression
forS3 source
. - bucket_
name str - The name of the bucket.
- consumer_
group str - custom_
services Sequence[S3SourcePath Custom Service] - event_
hub_ strname - limit_
to_ Sequence[str]namespaces - limit_
to_ Sequence[str]regions - limit_
to_ Sequence[str]services - namespace str
- path_
expression str - The path to the data.
- region str
- Your AWS Bucket region.
- sns_
topic_ Sequence[S3Sourceor_ subscription_ arns Path Sns Topic Or Subscription Arn] - This is a computed field for SNS topic/subscription ARN.
- tag_
filters Sequence[S3SourcePath Tag Filter] - use_
versioned_ boolapi - Whether to Use AWS versioned APIs. Default is set to
true
. If you're collecting from a Cisco Umbrella bucket this must be set tofalse
.
- type String
- type of polling source. This has to be
S3BucketPathExpression
forS3 source
. - bucket
Name String - The name of the bucket.
- consumer
Group String - custom
Services List<Property Map> - event
Hub StringName - limit
To List<String>Namespaces - limit
To List<String>Regions - limit
To List<String>Services - namespace String
- path
Expression String - The path to the data.
- region String
- Your AWS Bucket region.
- sns
Topic List<Property Map>Or Subscription Arns - This is a computed field for SNS topic/subscription ARN.
- tag
Filters List<Property Map> - use
Versioned BooleanApi - Whether to Use AWS versioned APIs. Default is set to
true
. If you're collecting from a Cisco Umbrella bucket this must be set tofalse
.
S3SourcePathCustomService, S3SourcePathCustomServiceArgs
- Prefixes List<string>
- Service
Name string
- Prefixes []string
- Service
Name string
- prefixes List<String>
- service
Name String
- prefixes string[]
- service
Name string
- prefixes Sequence[str]
- service_
name str
- prefixes List<String>
- service
Name String
S3SourcePathSnsTopicOrSubscriptionArn, S3SourcePathSnsTopicOrSubscriptionArnArgs
- arn str
- is_
success bool
S3SourcePathTagFilter, S3SourcePathTagFilterArgs
Import
S3 sources can be imported using the collector and source IDs (collector/source
), e.g.:
hcl
$ pulumi import sumologic:index/s3Source:S3Source test 123/456
S3 sources can be imported using the collector name and source name (collectorName/sourceName
), e.g.:
hcl
$ pulumi import sumologic:index/s3Source:S3Source test my-test-collector/my-test-source
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Sumo Logic pulumi/pulumi-sumologic
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
sumologic
Terraform Provider.